diff --git a/CHANGE_LOG/change-log.2.2.0.html b/CHANGE_LOG/change-log.2.2.0.html index bccc30ba..167ba595 100644 --- a/CHANGE_LOG/change-log.2.2.0.html +++ b/CHANGE_LOG/change-log.2.2.0.html @@ -34,6 +34,183 @@

Commit Range: v2.2.1..HEAD

+ + + 2019-07-05T08:46:14 05-Jul-2019 08:46 + karthik-sethuraman + + + OAS Files for TAPI 2.2 + + 
EAD -> refs/heads/develop, refs/remotes/origin/develop
+
+ + + + + + + 2019-07-01T11:41:20 01-Jul-2019 11:41 + karthik-sethuraman + + + Removed old OAS files in prep for 2.2-RC3 + + 
+
+ + + + + + + 2019-06-28T18:22:11 28-Jun-2019 18:22 + karthik-sethuraman + + + UML/YANG/TREE file updates to align & be consistent with PR #441 + + 
+- Updated all UML-Operations/YANG-RPCs to use UUIDs so that it is consistent
+with the REST CRUD data APIs flavor
+- used consistent labels (uuid) for the UUID key parameters and fixed parameter
+type to TapiCommon::Uuid (instead of String)
+- other minor bug fixes (explicit config=false statements)
+ + + + + + + 2019-06-28T14:32:47 28-Jun-2019 14:32 + Karthik Sethuraman + + + Yang updates related to PR #428 + + 
+- minor UML organization to move atrifacts into appropriate folders
+ + + + + + + 2019-06-28T10:57:15 28-Jun-2019 10:57 + Karthik Sethuraman + + + UML & corresponding Yang updates to align with PR #439 + + 
+- created an CentralFrequencyBand datatype and using that in OtsiCapability pac
+instead of in-lining as in previous Yang commit
+ + + + + + + 2019-06-26T10:10:50 26-Jun-2019 10:10 + amazzini + + + PathComputationService uuid, name + + 
+Issue #433, add "name" as input parameter of create and update 
+PathComputationService. Issue #340, add "UUID" as input parameter of create 
+PathComputationService.
+ + + + + + + 2019-06-26T10:06:36 26-Jun-2019 10:06 + amazzini + + + OAM Service/Job/Profile uuid,name,layerProtocolName + + 
+Issue #434, add "layerProtocolName" as input parameter of create OAM 
+Service/ServicePoint/Job/Profile. Issue #433, add "name" as input parameter of
+create and update OAM Service/ServicePoint/Job/Profile. Issue #340, add "UUID"
+as input parameter of create OAM Service/ServicePoint/Job/Profile.
+ + + + + + + 2019-06-26T10:03:22 26-Jun-2019 10:03 + amazzini + + + ConnectivityService uuid,name,layerProtocolName,direction + + 
+Issue #425, set “direction” attribute of ConnectivityService as read only. 
+Issue #434, add "layerProtocolName" as input parameter of create Connectivity
+Service. Issue #433, add "name" as input parameter of create and update 
+ConnectivityService. Issue #340, add "UUID" as input parameter of create
+ConnectivityService.
+ + + + + + + 2019-06-26T05:43:19 26-Jun-2019 05:43 + Arturo Mayoral + + + OTSI SIP spec #429 + + 
+This pull request replace current definition of the otsi tunability
+capabilities as two separate lists: supportable-lower-central-frequency and
+supportable-upper-central-frequency, by a single
+supportable-central-frequency-spectrum-band. After discussions into the TAPI
+calls on18/06/2019 and 25/06/2019, the group agreed on defining the tunabilty
+capabilities of otsi transmitters as a single list of bands defined by the
+lower and upper central frequencies of the band, and the frequency-contrains
+which specify the rest of feasible central frequencies within the band. An OTSi
+transmitter can have associated more than one band (i.e., C and L bands).
+
+ + + + + + + 2019-05-31T13:31:05 31-May-2019 13:31 + amazzini + + + Updated Ethernet TAPI Alarm Condition (G.8021/G.8051/G.806) + + 
+
+ + + + + + + 2019-05-24T08:22:34 24-May-2019 08:22 + karthik-sethuraman + + + Change-log for version 2.2.0-RC2 + + 
+
+ + + + 2019-05-23T13:07:09 23-May-2019 13:07 diff --git a/CHANGE_LOG/change-log.2.2.0.md b/CHANGE_LOG/change-log.2.2.0.md index 156240b9..f50bd6e8 100644 --- a/CHANGE_LOG/change-log.2.2.0.md +++ b/CHANGE_LOG/change-log.2.2.0.md @@ -1,6 +1,95 @@ # Change Log ## Commit Range: 2.1.1..HEAD +__[OAS Files for TAPI 2.2](https://github.com/OpenNetworkingFoundation/TAPI/commit/ad6d1b54eb103831b8480b4af1e39ad90a20b907)__ + + [karthik-sethuraman](mailto:karthik.sethuraman@necam.com) - Fri, 5 Jul 2019 08:46:14 -0400 + EAD -> refs/heads/develop, refs/remotes/origin/develop + + +__[Removed old OAS files in prep for 2.2-RC3](https://github.com/OpenNetworkingFoundation/TAPI/commit/6976123cae404bb883c8f4e05bfb6b72a1d774a4)__ + + [karthik-sethuraman](mailto:karthik.sethuraman@necam.com) - Mon, 1 Jul 2019 11:41:20 -0400 + + + +__[UML/YANG/TREE file updates to align & be consistent with PR #441](https://github.com/OpenNetworkingFoundation/TAPI/commit/fff795940f9f3a9cebe8971a2537cb6764228d61)__ + + [karthik-sethuraman](mailto:karthik.sethuraman@necam.com) - Fri, 28 Jun 2019 18:22:11 -0400 + + - Updated all UML-Operations/YANG-RPCs to use UUIDs so that it is consistent + with the REST CRUD data APIs flavor + - used consistent labels (uuid) for the UUID key parameters and fixed parameter + type to TapiCommon::Uuid (instead of String) + - other minor bug fixes (explicit config=false statements) + +__[Yang updates related to PR #428](https://github.com/OpenNetworkingFoundation/TAPI/commit/a7677de36cbcc1106862d506a046d054f570ff53)__ + + [Karthik Sethuraman](mailto:karthik.sethuraman@necam.com) - Fri, 28 Jun 2019 14:32:47 -0400 + + - minor UML organization to move atrifacts into appropriate folders + +__[UML & corresponding Yang updates to align with PR #439](https://github.com/OpenNetworkingFoundation/TAPI/commit/6655e1388d1f4be0ba3c8b29e4960505588940fb)__ + + [Karthik Sethuraman](mailto:karthik.sethuraman@necam.com) - Fri, 28 Jun 2019 10:57:15 -0400 + + - created an CentralFrequencyBand datatype and using that in OtsiCapability pac + instead of in-lining as in previous Yang commit + +__[PathComputationService uuid, name](https://github.com/OpenNetworkingFoundation/TAPI/commit/8440938381a33559d038d7ad3e614cd7f497caed)__ + + [amazzini](mailto:mazzini64@tiscali.it) - Wed, 26 Jun 2019 16:10:50 +0200 + + Issue #433, add "name" as input parameter of create and update + PathComputationService. Issue #340, add "UUID" as input parameter of create + PathComputationService. + +__[OAM Service/Job/Profile uuid,name,layerProtocolName](https://github.com/OpenNetworkingFoundation/TAPI/commit/8c47dee14af58affc44b0e54c7be37929b57b115)__ + + [amazzini](mailto:mazzini64@tiscali.it) - Wed, 26 Jun 2019 16:06:36 +0200 + + Issue #434, add "layerProtocolName" as input parameter of create OAM + Service/ServicePoint/Job/Profile. Issue #433, add "name" as input parameter of + create and update OAM Service/ServicePoint/Job/Profile. Issue #340, add "UUID" + as input parameter of create OAM Service/ServicePoint/Job/Profile. + +__[ConnectivityService uuid,name,layerProtocolName,direction](https://github.com/OpenNetworkingFoundation/TAPI/commit/58377da11763f33f44411206fa78ce28840cfcf2)__ + + [amazzini](mailto:mazzini64@tiscali.it) - Wed, 26 Jun 2019 16:03:22 +0200 + + Issue #425, set “direction” attribute of ConnectivityService as read only. + Issue #434, add "layerProtocolName" as input parameter of create Connectivity + Service. Issue #433, add "name" as input parameter of create and update + ConnectivityService. Issue #340, add "UUID" as input parameter of create + ConnectivityService. + +__[OTSI SIP spec #429](https://github.com/OpenNetworkingFoundation/TAPI/commit/955108a5491bf586f094dc9d398caecb110de1a4)__ + + [Arturo Mayoral](mailto:arturo.mayoral.ext@telefonica.com) - Wed, 26 Jun 2019 11:43:19 +0200 + + This pull request replace current definition of the otsi tunability + capabilities as two separate lists: supportable-lower-central-frequency and + supportable-upper-central-frequency, by a single + supportable-central-frequency-spectrum-band. After discussions into the TAPI + calls on18/06/2019 and 25/06/2019, the group agreed on defining the tunabilty + capabilities of otsi transmitters as a single list of bands defined by the + lower and upper central frequencies of the band, and the frequency-contrains + which specify the rest of feasible central frequencies within the band. An OTSi + transmitter can have associated more than one band (i.e., C and L bands). + + +__[Updated Ethernet TAPI Alarm Condition (G.8021/G.8051/G.806)](https://github.com/OpenNetworkingFoundation/TAPI/commit/a755b7dec3b99a9f367d3364a5f2cf6475f8ebe8)__ + + [amazzini](mailto:mazzini64@tiscali.it) - Fri, 31 May 2019 19:31:05 +0200 + + + +__[Change-log for version 2.2.0-RC2](https://github.com/OpenNetworkingFoundation/TAPI/commit/7823102f708488dff2228adb680b8ab88550700a)__ + + [karthik-sethuraman](mailto:karthik.sethuraman@necam.com) - Fri, 24 May 2019 08:22:34 -0400 + + + __[Changed the multiplicity of Connection.boundingNode to 0..1 from 1](https://github.com/OpenNetworkingFoundation/TAPI/commit/6b1379e25c1e42542ba8f48dcd02c76ac6efbcdf)__ [karthik-sethuraman](mailto:karthik.sethuraman@necam.com) - Thu, 23 May 2019 13:07:09 -0400 diff --git a/OAS/tapi-common@2018-12-10.yaml b/OAS/tapi-common@2019-03-31.yaml similarity index 60% rename from OAS/tapi-common@2018-12-10.yaml rename to OAS/tapi-common@2019-03-31.yaml index 0c9b5926..e040d25b 100644 --- a/OAS/tapi-common@2018-12-10.yaml +++ b/OAS/tapi-common@2019-03-31.yaml @@ -1,8 +1,24 @@ --- swagger: "2.0" info: - description: "tapi-common API generated from yang definitions" - version: "1.0" + description: "\r\n This module contains TAPI Common Model definitions.\r\n\ + \ Source: TapiCommon.uml\r\n Copyright (c) 2018 Open Networking\ + \ Foundation (ONF). All rights reserved.\r\n License: This module is distributed\ + \ under the Apache License 2.0\r\n - The TAPI YANG models included in this\ + \ TAPI release are a *normative* part of the TAPI SDK.\r\n - The YANG specifications\ + \ have been generated from the corresponding UML model using the [ONF EAGLE UML2YANG\ + \ mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases." + version: "2.2.0" title: "tapi-common API" host: "localhost:1234" consumes: @@ -14,7 +30,8 @@ paths: get: tags: - "tapi-common" - description: "returns tapi.common.TapiContext" + summary: "returns tapi.common.TapiContext" + description: "none" parameters: [] responses: 200: @@ -26,7 +43,8 @@ paths: post: tags: - "tapi-common" - description: "creates tapi.common.TapiContext" + summary: "creates tapi.common.TapiContext" + description: "none" parameters: - in: "body" name: "tapi.common.TapiContext.body-param" @@ -44,7 +62,8 @@ paths: put: tags: - "tapi-common" - description: "creates or updates tapi.common.TapiContext" + summary: "creates or updates tapi.common.TapiContext" + description: "none" parameters: - in: "body" name: "tapi.common.TapiContext.body-param" @@ -62,7 +81,8 @@ paths: delete: tags: - "tapi-common" - description: "removes tapi.common.TapiContext" + summary: "removes tapi.common.TapiContext" + description: "none" parameters: [] responses: 400: @@ -73,7 +93,10 @@ paths: post: tags: - "tapi-common" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - in: "body" name: "tapi.common.NameAndValue.body-param" @@ -92,7 +115,10 @@ paths: get: tags: - "tapi-common" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "value-name" in: "path" @@ -106,33 +132,13 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-common" - description: "creates or updates tapi.common.NameAndValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "value-name" in: "path" @@ -155,7 +161,10 @@ paths: delete: tags: - "tapi-common" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "value-name" in: "path" @@ -171,7 +180,8 @@ paths: post: tags: - "tapi-common" - description: "creates tapi.common.ServiceInterfacePoint" + summary: "creates tapi.common.ServiceInterfacePoint" + description: "none" parameters: - in: "body" name: "tapi.common.ServiceInterfacePoint.body-param" @@ -190,7 +200,8 @@ paths: get: tags: - "tapi-common" - description: "returns tapi.common.ServiceInterfacePoint" + summary: "returns tapi.common.ServiceInterfacePoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -204,33 +215,11 @@ paths: $ref: "#/definitions/tapi.common.ServiceInterfacePoint" 400: description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.ServiceInterfacePoint.body-param" - description: "tapi.common.ServiceInterfacePoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-common" - description: "creates or updates tapi.common.ServiceInterfacePoint" + summary: "creates or updates tapi.common.ServiceInterfacePoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -253,7 +242,8 @@ paths: delete: tags: - "tapi-common" - description: "removes tapi.common.ServiceInterfacePoint" + summary: "removes tapi.common.ServiceInterfacePoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -269,7 +259,8 @@ paths: get: tags: - "tapi-common" - description: "returns tapi.common.Capacity" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" @@ -283,101 +274,13 @@ paths: $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/committed-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" /data/context/service-interface-point={uuid}/available-capacity/total-size/: get: tags: - "tapi-common" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -395,7 +298,10 @@ paths: post: tags: - "tapi-common" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -419,7 +325,10 @@ paths: get: tags: - "tapi-common" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -438,38 +347,13 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-common" - description: "creates or updates tapi.common.NameAndValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -497,7 +381,10 @@ paths: delete: tags: - "tapi-common" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -518,7 +405,9 @@ paths: get: tags: - "tapi-common" - description: "returns tapi.common.Capacity" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" @@ -532,101 +421,13 @@ paths: $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" /data/context/service-interface-point={uuid}/total-potential-capacity/total-size/: get: tags: - "tapi-common" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -644,6 +445,8 @@ paths: post: tags: - "tapi-common" + summary: "operates on tapi.common.GetServiceInterfacePointDetails" + description: "operates on tapi.common.GetServiceInterfacePointDetails" parameters: - in: "body" name: "tapi.common.getserviceinterfacepointdetails.Input.body-param" @@ -679,6 +482,8 @@ paths: post: tags: - "tapi-common" + summary: "operates on tapi.common.UpdateServiceInterfacePoint" + description: "operates on tapi.common.UpdateServiceInterfacePoint" parameters: - in: "body" name: "tapi.common.updateserviceinterfacepoint.Input.body-param" @@ -710,45 +515,9 @@ definitions: enum: - "LOCKED" - "UNLOCKED" - tapi.common.BandwidthProfile: - type: "object" - properties: - committed-information-rate: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - coupling-flag: - type: "boolean" - description: "none" - default: false - bw-profile-type: - description: "none" - $ref: "#/definitions/tapi.common.BandwidthProfileType" - peak-information-rate: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - committed-burst-size: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - peak-burst-size: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - color-aware: - type: "boolean" - description: "none" - default: false - tapi.common.BandwidthProfileType: - type: "string" - enum: - - "MEF_10.x" - - "RFC_2697" - - "RFC_2698" - - "RFC_4115" tapi.common.Capacity: type: "object" properties: - bandwidth-profile: - description: "none" - $ref: "#/definitions/tapi.common.BandwidthProfile" total-size: description: "Total capacity of the TopologicalEntity in MB/s. In case of\ \ bandwidthProfile, this is expected to same as the committedInformationRate." @@ -801,21 +570,21 @@ definitions: properties: name: type: "array" - description: "List of names. A property of an entity with a value that is\ - \ unique in some namespace but may change during the life of the entity.\ - \ A name carries no semantics with respect to the purpose of the entity." + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." items: $ref: "#/definitions/tapi.common.NameAndValue" uuid: type: "string" description: "UUID: An identifier that is universally unique within an identifier\ - \ space, where the identifier space is itself globally unique, and immutable.\ - \ An UUID carries no semantics with respect to the purpose or state of the\ - \ entity.\r\n UUID here uses string representation as\ - \ defined in RFC 4122. The canonical representation uses lowercase characters.\r\ - \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ - \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ - \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a UUID\ + \ in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.common.LayerProtocolName: type: "string" enum: @@ -863,7 +632,7 @@ definitions: $ref: "#/definitions/tapi.common.LayerProtocolName" description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ \ termination and adaptation functions of one or more transport layers. \r\ - \n The structure of LTP supports all transport protocols including\ + \n The structure of LTP supports all transport protocols including\ \ circuit and packet forms." tapi.common.TapiContext: allOf: @@ -882,9 +651,16 @@ definitions: tapi.common.getserviceinterfacepointdetails.Input: type: "object" properties: - sip-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.common.getserviceinterfacepointdetails.Output: type: "object" properties: @@ -902,9 +678,16 @@ definitions: tapi.common.updateserviceinterfacepoint.Input: type: "object" properties: - sip-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" state: description: "none" $ref: "#/definitions/tapi.common.AdministrativeState" diff --git a/OAS/tapi-connectivity@2018-12-10.yaml b/OAS/tapi-connectivity@2019-03-31.yaml similarity index 66% rename from OAS/tapi-connectivity@2018-12-10.yaml rename to OAS/tapi-connectivity@2019-03-31.yaml index 0f224a67..eb342dd1 100644 --- a/OAS/tapi-connectivity@2018-12-10.yaml +++ b/OAS/tapi-connectivity@2019-03-31.yaml @@ -1,10 +1,89 @@ --- swagger: "2.0" info: - description: "tapi-path-computation,tapi-connectivity,tapi-notification,tapi-topology,tapi-common\ - \ API generated from yang definitions" - version: "1.0" - title: "tapi-path-computation,tapi-connectivity,tapi-notification,tapi-topology,tapi-common\ + description: "\r\n This module contains TAPI Notification Model definitions.\r\ + \n Source: TapiNotification.uml\r\n Copyright (c) 2018 Open Networking\ + \ Foundation (ONF). All rights reserved.\r\n License: This module is distributed\ + \ under the Apache License 2.0\r\n - The TAPI YANG models included in this\ + \ TAPI release are a *normative* part of the TAPI SDK.\r\n - The YANG specifications\ + \ have been generated from the corresponding UML model using the [ONF EAGLE UML2YANG\ + \ mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Topology\ + \ Model definitions.\r\n Source: TapiTopology.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Common Model\ + \ definitions.\r\n Source: TapiCommon.uml\r\n Copyright (c) 2018\ + \ Open Networking Foundation (ONF). All rights reserved.\r\n License: This\ + \ module is distributed under the Apache License 2.0\r\n - The TAPI YANG\ + \ models included in this TAPI release are a *normative* part of the TAPI SDK.\r\ + \n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Path Computation\ + \ Model definitions.\r\n Source: TapiPathComputation.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Connectivity\ + \ Model definitions.\r\n Source: TapiConnectivity.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases." + version: "2.2.0" + title: "tapi-notification,tapi-topology,tapi-common,tapi-path-computation,tapi-connectivity\ \ API" host: "localhost:1234" consumes: @@ -16,7 +95,8 @@ paths: get: tags: - "tapi-common" - description: "returns tapi.common.Context" + summary: "returns tapi.common.Context" + description: "none" parameters: [] responses: 200: @@ -28,7 +108,8 @@ paths: post: tags: - "tapi-common" - description: "creates tapi.common.Context" + summary: "creates tapi.common.Context" + description: "none" parameters: - in: "body" name: "tapi.common.Context.body-param" @@ -46,7 +127,8 @@ paths: put: tags: - "tapi-common" - description: "creates or updates tapi.common.Context" + summary: "creates or updates tapi.common.Context" + description: "none" parameters: - in: "body" name: "tapi.common.Context.body-param" @@ -64,7 +146,8 @@ paths: delete: tags: - "tapi-common" - description: "removes tapi.common.Context" + summary: "removes tapi.common.Context" + description: "none" parameters: [] responses: 400: @@ -75,7 +158,8 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityContext" + summary: "returns tapi.connectivity.ConnectivityContext" + description: "Augments the base TAPI Context with ConnectivityService information" parameters: [] responses: 200: @@ -87,7 +171,8 @@ paths: post: tags: - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityContext" + summary: "creates tapi.connectivity.ConnectivityContext" + description: "Augments the base TAPI Context with ConnectivityService information" parameters: - in: "body" name: "tapi.connectivity.ConnectivityContext.body-param" @@ -105,7 +190,8 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityContext" + summary: "creates or updates tapi.connectivity.ConnectivityContext" + description: "Augments the base TAPI Context with ConnectivityService information" parameters: - in: "body" name: "tapi.connectivity.ConnectivityContext.body-param" @@ -123,7 +209,8 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityContext" + summary: "removes tapi.connectivity.ConnectivityContext" + description: "Augments the base TAPI Context with ConnectivityService information" parameters: [] responses: 400: @@ -134,7 +221,8 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.Connection" + summary: "returns tapi.connectivity.Connection" + description: "none" parameters: - name: "uuid" in: "path" @@ -148,11 +236,31 @@ paths: $ref: "#/definitions/tapi.connectivity.Connection" 400: description: "Internal error" + /data/context/connectivity-context/connection={uuid}/bounding-node/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.topology.NodeRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connection" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeRef" + schema: + $ref: "#/definitions/tapi.topology.NodeRef" + 400: + description: "Internal error" ? /data/context/connectivity-context/connection={uuid}/connection-end-point={topology-uuid},{node-uuid},{node-edge-point-uuid},{connection-end-point-uuid}/ : get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionEndPointRef" + summary: "returns tapi.connectivity.ConnectionEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -190,7 +298,14 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionRef" + summary: "returns tapi.connectivity.ConnectionRef" + description: "An Connection object supports a recursive aggregation relationship\ + \ such that the internal construction of an Connection can be exposed as multiple\ + \ lower level Connection objects (partitioning).\r\n Aggregation\ + \ is used as for the Node/Topology to allow changes in hierarchy. \r\n \ + \ Connection aggregation reflects Node/Topology aggregation.\ + \ \r\n The FC represents a Cross-Connection in an NE. The Cross-Connection\ + \ in an NE is not necessarily the lowest level of FC partitioning." parameters: - name: "uuid" in: "path" @@ -213,7 +328,10 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -236,7 +354,8 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.Route" + summary: "returns tapi.connectivity.Route" + description: "none" parameters: - name: "uuid" in: "path" @@ -259,7 +378,8 @@ paths: : get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionEndPointRef" + summary: "returns tapi.connectivity.ConnectionEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -302,7 +422,10 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -330,7 +453,8 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.topology.LinkRef" + summary: "returns tapi.topology.LinkRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -358,7 +482,8 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.SwitchControl" + summary: "returns tapi.connectivity.SwitchControl" + description: "none" parameters: - name: "uuid" in: "path" @@ -381,7 +506,10 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -405,34 +533,12 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/resilience-type/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.ResilienceType" - parameters: - - name: "uuid" - in: "path" - description: "Id of connection" - required: true - type: "string" - - name: "switch-control-uuid" - in: "path" - description: "Id of switch-control" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.ResilienceType" - schema: - $ref: "#/definitions/tapi.topology.ResilienceType" - 400: - description: "Internal error" ? /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/sub-switch-control={connection-uuid},{sub-switch-control-switch-control-uuid}/ : get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.SwitchControlRef" + summary: "returns tapi.connectivity.SwitchControlRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -465,7 +571,8 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.Switch" + summary: "returns tapi.connectivity.Switch" + description: "none" parameters: - name: "uuid" in: "path" @@ -493,7 +600,10 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -526,7 +636,8 @@ paths: : get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionEndPointRef" + summary: "returns tapi.connectivity.ConnectionEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -574,7 +685,8 @@ paths: : get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.RouteRef" + summary: "returns tapi.connectivity.RouteRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -612,7 +724,8 @@ paths: post: tags: - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityService" + summary: "creates tapi.connectivity.ConnectivityService" + description: "none" parameters: - in: "body" name: "tapi.connectivity.ConnectivityService.body-param" @@ -631,7 +744,8 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityService" + summary: "returns tapi.connectivity.ConnectivityService" + description: "none" parameters: - name: "uuid" in: "path" @@ -645,33 +759,11 @@ paths: $ref: "#/definitions/tapi.connectivity.ConnectivityService" 400: description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityService" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.connectivity.ConnectivityService.body-param" - description: "tapi.connectivity.ConnectivityService to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityService" + summary: "creates or updates tapi.connectivity.ConnectivityService" + description: "none" parameters: - name: "uuid" in: "path" @@ -694,7 +786,8 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityService" + summary: "removes tapi.connectivity.ConnectivityService" + description: "none" parameters: - name: "uuid" in: "path" @@ -706,34 +799,12 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/avoid-topology={topology-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of avoid-topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" /data/context/connectivity-context/connectivity-service={uuid}/connection={connection-uuid}/: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionRef" + summary: "returns tapi.connectivity.ConnectionRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -752,11 +823,12 @@ paths: $ref: "#/definitions/tapi.connectivity.ConnectionRef" 400: description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/coroute-inclusion/: + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityServiceRef" + summary: "returns tapi.connectivity.ConnectivityConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -765,15 +837,16 @@ paths: type: "string" responses: 200: - description: "tapi.connectivity.ConnectivityServiceRef" + description: "tapi.connectivity.ConnectivityConstraint" schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" 400: description: "Internal error" post: tags: - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceRef" + summary: "creates tapi.connectivity.ConnectivityConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -781,11 +854,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.connectivity.ConnectivityServiceRef.body-param" - description: "tapi.connectivity.ConnectivityServiceRef to be added to list" + name: "tapi.connectivity.ConnectivityConstraint.body-param" + description: "tapi.connectivity.ConnectivityConstraint to be added to list" required: false schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" responses: 201: description: "Object created" @@ -796,7 +869,8 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityServiceRef" + summary: "creates or updates tapi.connectivity.ConnectivityConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -804,11 +878,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.connectivity.ConnectivityServiceRef.body-param" - description: "tapi.connectivity.ConnectivityServiceRef to be added or updated" + name: "tapi.connectivity.ConnectivityConstraint.body-param" + description: "tapi.connectivity.ConnectivityConstraint to be added or updated" required: false schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" responses: 201: description: "Object created" @@ -819,7 +893,8 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityServiceRef" + summary: "removes tapi.connectivity.ConnectivityConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -831,74 +906,42 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/cost-characteristic/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/cost-characteristic={cost-name}/: + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/coroute-inclusion/: get: tags: - "tapi-connectivity" - description: "returns tapi.topology.CostCharacteristic" + summary: "returns tapi.connectivity.ConnectivityServiceRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" responses: 200: - description: "tapi.topology.CostCharacteristic" + description: "tapi.connectivity.ConnectivityServiceRef" schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" 400: description: "Internal error" post: tags: - "tapi-connectivity" - description: "creates tapi.topology.CostCharacteristic" + summary: "creates tapi.connectivity.ConnectivityServiceRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" + name: "tapi.connectivity.ConnectivityServiceRef.body-param" + description: "tapi.connectivity.ConnectivityServiceRef to be added to list" required: false schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" responses: 201: description: "Object created" @@ -909,24 +952,20 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.topology.CostCharacteristic" + summary: "creates or updates tapi.connectivity.ConnectivityServiceRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added or updated" + name: "tapi.connectivity.ConnectivityServiceRef.body-param" + description: "tapi.connectivity.ConnectivityServiceRef to be added or updated" required: false schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" responses: 201: description: "Object created" @@ -937,28 +976,25 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.topology.CostCharacteristic" + summary: "removes tapi.connectivity.ConnectivityServiceRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/diversity-exclusion/: + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/diversity-exclusion/: post: tags: - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceRef" + summary: "creates tapi.connectivity.ConnectivityServiceRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -978,11 +1014,12 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/diversity-exclusion={connectivity-service-uuid}/: - get: + ? /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/diversity-exclusion={connectivity-service-uuid}/ + : get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityServiceRef" + summary: "returns tapi.connectivity.ConnectivityServiceRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1001,10 +1038,11 @@ paths: $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" 400: description: "Internal error" - post: + put: tags: - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceRef" + summary: "creates or updates tapi.connectivity.ConnectivityServiceRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1018,7 +1056,7 @@ paths: type: "string" - in: "body" name: "tapi.connectivity.ConnectivityServiceRef.body-param" - description: "tapi.connectivity.ConnectivityServiceRef to be added to list" + description: "tapi.connectivity.ConnectivityServiceRef to be added or updated" required: false schema: $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" @@ -1027,12 +1065,13 @@ paths: description: "Object created" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + 204: + description: "Object modified" + delete: tags: - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityServiceRef" + summary: "removes tapi.connectivity.ConnectivityServiceRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1044,44 +1083,35 @@ paths: description: "Id of diversity-exclusion" required: true type: "string" - - in: "body" - name: "tapi.connectivity.ConnectivityServiceRef.body-param" - description: "tapi.connectivity.ConnectivityServiceRef to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" responses: - 201: - description: "Object created" 400: description: "Internal error" 204: - description: "Object modified" - delete: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/requested-capacity/: + get: tags: - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityServiceRef" + summary: "returns tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "connectivity-service-uuid" - in: "path" - description: "Id of diversity-exclusion" - required: true - type: "string" responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point/: post: tags: - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceEndPoint" + summary: "creates tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" @@ -1089,12 +1119,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.connectivity.ConnectivityServiceEndPoint.body-param" - description: "tapi.connectivity.ConnectivityServiceEndPoint to be added to\ - \ list" + name: "tapi.common.Capacity.body-param" + description: "tapi.common.Capacity to be added to list" required: false schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" + $ref: "#/definitions/tapi.common.Capacity" responses: 201: description: "Object created" @@ -1102,51 +1131,84 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/: - get: + put: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityServiceEndPoint" + summary: "creates or updates tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" + - in: "body" + name: "tapi.common.Capacity.body-param" + description: "tapi.common.Capacity to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.Capacity" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.common.Capacity" + description: "none" + parameters: + - name: "uuid" in: "path" - description: "Id of end-point" + description: "Id of connectivity-service" required: true type: "string" responses: - 200: - description: "tapi.connectivity.ConnectivityServiceEndPoint" - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" 400: description: "Internal error" - post: + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/requested-capacity/total-size/: + get: tags: - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceEndPoint" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" required: true type: "string" - in: "body" - name: "tapi.connectivity.ConnectivityServiceEndPoint.body-param" - description: "tapi.connectivity.ConnectivityServiceEndPoint to be added to\ - \ list" + name: "tapi.common.CapacityValue.body-param" + description: "tapi.common.CapacityValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" + $ref: "#/definitions/tapi.common.CapacityValue" responses: 201: description: "Object created" @@ -1157,25 +1219,21 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityServiceEndPoint" + summary: "creates or updates tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - in: "body" - name: "tapi.connectivity.ConnectivityServiceEndPoint.body-param" - description: "tapi.connectivity.ConnectivityServiceEndPoint to be added or\ - \ updated" + name: "tapi.common.CapacityValue.body-param" + description: "tapi.common.CapacityValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" + $ref: "#/definitions/tapi.common.CapacityValue" responses: 201: description: "Object created" @@ -1186,67 +1244,56 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityServiceEndPoint" + summary: "removes tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/: + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/schedule/: get: tags: - "tapi-connectivity" - description: "returns tapi.common.Capacity" + summary: "returns tapi.common.TimeRange" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" responses: 200: - description: "tapi.common.Capacity" + description: "tapi.common.TimeRange" schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.common.TimeRange" 400: description: "Internal error" post: tags: - "tapi-connectivity" - description: "creates tapi.common.Capacity" + summary: "creates tapi.common.TimeRange" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - in: "body" - name: "tapi.common.Capacity.body-param" - description: "tapi.common.Capacity to be added to list" + name: "tapi.common.TimeRange.body-param" + description: "tapi.common.TimeRange to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.common.TimeRange" responses: 201: description: "Object created" @@ -1257,24 +1304,20 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.Capacity" + summary: "creates or updates tapi.common.TimeRange" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - in: "body" - name: "tapi.common.Capacity.body-param" - description: "tapi.common.Capacity to be added or updated" + name: "tapi.common.TimeRange.body-param" + description: "tapi.common.TimeRange to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.common.TimeRange" responses: 201: description: "Object created" @@ -1285,50 +1328,51 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.Capacity" + summary: "removes tapi.common.TimeRange" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/: - get: + /data/context/connectivity-context/connectivity-service={uuid}/end-point/: + post: tags: - "tapi-connectivity" - description: "returns tapi.common.BandwidthProfile" + summary: "creates tapi.connectivity.ConnectivityServiceEndPoint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" + - in: "body" + name: "tapi.connectivity.ConnectivityServiceEndPoint.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPoint to be added to\ + \ list" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/: + get: tags: - "tapi-connectivity" - description: "creates tapi.common.BandwidthProfile" + summary: "returns tapi.connectivity.ConnectivityServiceEndPoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -1340,23 +1384,18 @@ paths: description: "Id of end-point" required: true type: "string" - - in: "body" - name: "tapi.common.BandwidthProfile.body-param" - description: "tapi.common.BandwidthProfile to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" responses: - 201: - description: "Object created" + 200: + description: "tapi.connectivity.ConnectivityServiceEndPoint" + schema: + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.BandwidthProfile" + summary: "creates or updates tapi.connectivity.ConnectivityServiceEndPoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -1369,11 +1408,12 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.BandwidthProfile.body-param" - description: "tapi.common.BandwidthProfile to be added or updated" + name: "tapi.connectivity.ConnectivityServiceEndPoint.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPoint to be added or\ + \ updated" required: false schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" responses: 201: description: "Object created" @@ -1384,7 +1424,8 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.BandwidthProfile" + summary: "removes tapi.connectivity.ConnectivityServiceEndPoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -1401,11 +1442,12 @@ paths: description: "Internal error" 204: description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-burst-size/ - : get: + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/: + get: tags: - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" @@ -1419,15 +1461,16 @@ paths: type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" post: tags: - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + summary: "creates tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" @@ -1440,11 +1483,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.common.Capacity.body-param" + description: "tapi.common.Capacity to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" responses: 201: description: "Object created" @@ -1455,7 +1498,8 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" @@ -1468,11 +1512,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.common.Capacity.body-param" + description: "tapi.common.Capacity to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" responses: 201: description: "Object created" @@ -1483,7 +1527,8 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" @@ -1500,11 +1545,13 @@ paths: description: "Internal error" 204: description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-information-rate/ - : get: + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/total-size/: + get: tags: - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -1526,7 +1573,9 @@ paths: post: tags: - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + summary: "creates tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -1554,7 +1603,9 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -1582,7 +1633,9 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -1599,11 +1652,12 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-burst-size/: - get: + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/connection-end-point={topology-uuid},{node-uuid},{node-edge-point-uuid},{connection-end-point-uuid}/ + : get: tags: - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.connectivity.ConnectionEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1615,17 +1669,41 @@ paths: description: "Id of end-point" required: true type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.connectivity.ConnectionEndPointRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.connectivity.ConnectionEndPointRef" 400: description: "Internal error" + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/name/: post: tags: - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -1638,11 +1716,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -1650,10 +1728,44 @@ paths: description: "Internal error" 409: description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/name={value-name}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -1665,12 +1777,17 @@ paths: description: "Id of end-point" required: true type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -1681,7 +1798,10 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -1693,16 +1813,22 @@ paths: description: "Id of end-point" required: true type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-information-rate/ - : get: + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/peer-fwd-connectivity-service-end-point/: + get: tags: - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1716,15 +1842,16 @@ paths: type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.connectivity.ConnectivityServiceEndPointRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" 400: description: "Internal error" post: tags: - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + summary: "creates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1737,11 +1864,12 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" responses: 201: description: "Object created" @@ -1752,7 +1880,8 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1765,11 +1894,12 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" responses: 201: description: "Object created" @@ -1780,7 +1910,8 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1797,11 +1928,12 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/total-size/: + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/protecting-connectivity-service-end-point/: get: tags: - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1815,15 +1947,16 @@ paths: type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.connectivity.ConnectivityServiceEndPointRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" 400: description: "Internal error" post: tags: - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + summary: "creates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1836,11 +1969,12 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" responses: 201: description: "Object created" @@ -1851,7 +1985,8 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1864,11 +1999,12 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" responses: 201: description: "Object created" @@ -1879,7 +2015,8 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1896,83 +2033,12 @@ paths: description: "Internal error" 204: description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/connection-end-point={topology-uuid},{node-uuid},{node-edge-point-uuid},{connection-end-point-uuid}/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.connectivity.ConnectionEndPointRef" - schema: - $ref: "#/definitions/tapi.connectivity.ConnectionEndPointRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/name/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/name={value-name}/: + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/server-connectivity-service-end-point/: get: tags: - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1984,22 +2050,18 @@ paths: description: "Id of end-point" required: true type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.connectivity.ConnectivityServiceEndPointRef" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" 400: description: "Internal error" post: tags: - "tapi-connectivity" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -2011,17 +2073,13 @@ paths: description: "Id of end-point" required: true type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ to list" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" responses: 201: description: "Object created" @@ -2032,7 +2090,8 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.NameAndValue" + summary: "creates or updates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -2044,17 +2103,13 @@ paths: description: "Id of end-point" required: true type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ or updated" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" responses: 201: description: "Object created" @@ -2065,7 +2120,8 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -2077,11 +2133,6 @@ paths: description: "Id of end-point" required: true type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" responses: 400: description: "Internal error" @@ -2091,7 +2142,8 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.common.ServiceInterfacePointRef" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -2113,7 +2165,8 @@ paths: post: tags: - "tapi-connectivity" - description: "creates tapi.common.ServiceInterfacePointRef" + summary: "creates tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -2141,7 +2194,8 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.ServiceInterfacePointRef" + summary: "creates or updates tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -2169,7 +2223,8 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.ServiceInterfacePointRef" + summary: "removes tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -2186,192 +2241,220 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/exclude-link={topology-uuid},{link-uuid}/: - get: + /data/context/connectivity-context/connectivity-service={uuid}/name/: + post: tags: - "tapi-connectivity" - description: "returns tapi.topology.LinkRef" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of exclude-link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of exclude-link" - required: true - type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/exclude-node={topology-uuid},{node-uuid}/: + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/name={value-name}/: get: tags: - "tapi-connectivity" - description: "returns tapi.topology.NodeRef" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of exclude-node" - required: true - type: "string" - - name: "node-uuid" + - name: "value-name" in: "path" - description: "Id of exclude-node" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.topology.NodeRef" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.topology.NodeRef" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/exclude-path={path-uuid}/: - get: + put: tags: - "tapi-connectivity" - description: "returns tapi.path.computation.PathRef" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "path-uuid" + - name: "value-name" in: "path" - description: "Id of exclude-path" + description: "Id of name" required: true type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/include-link={topology-uuid},{link-uuid}/: - get: + 204: + description: "Object modified" + delete: tags: - "tapi-connectivity" - description: "returns tapi.topology.LinkRef" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-link" - required: true - type: "string" - - name: "link-uuid" + - name: "value-name" in: "path" - description: "Id of include-link" + description: "Id of name" required: true type: "string" responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" 400: description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/include-node={topology-uuid},{node-uuid}/: + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/resilience-constraint/: get: tags: - "tapi-connectivity" - description: "returns tapi.topology.NodeRef" + summary: "returns tapi.connectivity.ResilienceConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-node" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of include-node" - required: true - type: "string" responses: 200: - description: "tapi.topology.NodeRef" + description: "tapi.connectivity.ResilienceConstraint" schema: - $ref: "#/definitions/tapi.topology.NodeRef" + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" 400: description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/include-path={path-uuid}/: - get: + post: tags: - "tapi-connectivity" - description: "returns tapi.path.computation.PathRef" + summary: "creates tapi.connectivity.ResilienceConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "path-uuid" + - in: "body" + name: "tapi.connectivity.ResilienceConstraint.body-param" + description: "tapi.connectivity.ResilienceConstraint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.connectivity.ResilienceConstraint" + description: "none" + parameters: + - name: "uuid" in: "path" - description: "Id of include-path" + description: "Id of connectivity-service" required: true type: "string" + - in: "body" + name: "tapi.connectivity.ResilienceConstraint.body-param" + description: "tapi.connectivity.ResilienceConstraint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/include-topology={topology-uuid}/: - get: + 204: + description: "Object modified" + delete: tags: - "tapi-connectivity" - description: "returns tapi.topology.TopologyRef" + summary: "removes tapi.connectivity.ResilienceConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "topology-uuid" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" in: "path" - description: "Id of include-topology" + description: "Id of connectivity-service" required: true type: "string" responses: 200: - description: "tapi.topology.TopologyRef" + description: "tapi.path.computation.RoutingConstraint" schema: - $ref: "#/definitions/tapi.topology.TopologyRef" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" 400: description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/latency-characteristic/: post: tags: - "tapi-connectivity" - description: "creates tapi.topology.LatencyCharacteristic" + summary: "creates tapi.path.computation.RoutingConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -2379,11 +2462,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" + name: "tapi.path.computation.RoutingConstraint.body-param" + description: "tapi.path.computation.RoutingConstraint to be added to list" required: false schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" responses: 201: description: "Object created" @@ -2391,50 +2474,65 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/latency-characteristic={traffic-property-name}/: - get: + put: tags: - "tapi-connectivity" - description: "returns tapi.topology.LatencyCharacteristic" + summary: "creates or updates tapi.path.computation.RoutingConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "traffic-property-name" + - in: "body" + name: "tapi.path.computation.RoutingConstraint.body-param" + description: "tapi.path.computation.RoutingConstraint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" in: "path" - description: "Id of latency-characteristic" + description: "Id of connectivity-service" required: true type: "string" responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/cost-characteristic/: post: tags: - "tapi-connectivity" - description: "creates tapi.topology.LatencyCharacteristic" + summary: "creates tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" + name: "tapi.topology.CostCharacteristic.body-param" + description: "tapi.topology.CostCharacteristic to be added to list" required: false schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + $ref: "#/definitions/tapi.topology.CostCharacteristic" responses: 201: description: "Object created" @@ -2442,27 +2540,54 @@ paths: description: "Internal error" 409: description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/cost-characteristic={cost-name}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" put: tags: - "tapi-connectivity" - description: "creates or updates tapi.topology.LatencyCharacteristic" + summary: "creates or updates tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "traffic-property-name" + - name: "cost-name" in: "path" - description: "Id of latency-characteristic" + description: "Id of cost-characteristic" required: true type: "string" - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added or updated" + name: "tapi.topology.CostCharacteristic.body-param" + description: "tapi.topology.CostCharacteristic to be added or updated" required: false schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + $ref: "#/definitions/tapi.topology.CostCharacteristic" responses: 201: description: "Object created" @@ -2473,16 +2598,18 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.topology.LatencyCharacteristic" + summary: "removes tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "traffic-property-name" + - name: "cost-name" in: "path" - description: "Id of latency-characteristic" + description: "Id of cost-characteristic" required: true type: "string" responses: @@ -2490,11 +2617,13 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/name/: + /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/latency-characteristic/: post: tags: - "tapi-connectivity" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" @@ -2502,11 +2631,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.topology.LatencyCharacteristic.body-param" + description: "tapi.topology.LatencyCharacteristic to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" responses: 201: description: "Object created" @@ -2514,78 +2643,54 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/name={value-name}/: - get: + ? /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/ + : get: tags: - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "value-name" + - name: "traffic-property-name" in: "path" - description: "Id of name" + description: "Id of latency-characteristic" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.topology.LatencyCharacteristic" schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.NameAndValue" + summary: "creates or updates tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "value-name" + - name: "traffic-property-name" in: "path" - description: "Id of name" + description: "Id of latency-characteristic" required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" + name: "tapi.topology.LatencyCharacteristic.body-param" + description: "tapi.topology.LatencyCharacteristic to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" responses: 201: description: "Object created" @@ -2596,16 +2701,18 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "value-name" + - name: "traffic-property-name" in: "path" - description: "Id of name" + description: "Id of latency-characteristic" required: true type: "string" responses: @@ -2613,63 +2720,77 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/: - get: + /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/risk-diversity-characteristic/: + post: tags: - "tapi-connectivity" - description: "returns tapi.common.Capacity" + summary: "creates tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - in: "body" + name: "tapi.topology.RiskCharacteristic.body-param" + description: "tapi.topology.RiskCharacteristic to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + ? /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/ + : get: tags: - "tapi-connectivity" - description: "creates tapi.common.Capacity" + summary: "returns tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - in: "body" - name: "tapi.common.Capacity.body-param" - description: "tapi.common.Capacity to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.Capacity" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-diversity-characteristic" + required: true + type: "string" responses: - 201: - description: "Object created" + 200: + description: "tapi.topology.RiskCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.Capacity" + summary: "creates or updates tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-diversity-characteristic" + required: true + type: "string" - in: "body" - name: "tapi.common.Capacity.body-param" - description: "tapi.common.Capacity to be added or updated" + name: "tapi.topology.RiskCharacteristic.body-param" + description: "tapi.topology.RiskCharacteristic to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.topology.RiskCharacteristic" responses: 201: description: "Object created" @@ -2680,75 +2801,95 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.Capacity" + summary: "removes tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-diversity-characteristic" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/: - get: + /data/context/connectivity-context/connectivity-service={uuid}/topology-constraint/: + post: tags: - "tapi-connectivity" - description: "returns tapi.common.BandwidthProfile" + summary: "creates tapi.path.computation.TopologyConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - in: "body" + name: "tapi.path.computation.TopologyConstraint.body-param" + description: "tapi.path.computation.TopologyConstraint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/topology-constraint={local-id}/: + get: tags: - "tapi-connectivity" - description: "creates tapi.common.BandwidthProfile" + summary: "returns tapi.path.computation.TopologyConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - in: "body" - name: "tapi.common.BandwidthProfile.body-param" - description: "tapi.common.BandwidthProfile to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" responses: - 201: - description: "Object created" + 200: + description: "tapi.path.computation.TopologyConstraint" + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.BandwidthProfile" + summary: "creates or updates tapi.path.computation.TopologyConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" - in: "body" - name: "tapi.common.BandwidthProfile.body-param" - description: "tapi.common.BandwidthProfile to be added or updated" + name: "tapi.path.computation.TopologyConstraint.body-param" + description: "tapi.path.computation.TopologyConstraint to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" responses: 201: description: "Object created" @@ -2759,52 +2900,49 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.BandwidthProfile" + summary: "removes tapi.path.computation.TopologyConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/committed-burst-size/: - get: + /data/context/connectivity-context/connectivity-service={uuid}/topology-constraint={local-id}/name/: + post: tags: - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" + - name: "local-id" in: "path" - description: "Id of connectivity-service" + description: "Id of topology-constraint" required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -2812,78 +2950,116 @@ paths: description: "Internal error" 409: description: "Object already exists" - put: + /data/context/connectivity-context/connectivity-service={uuid}/topology-constraint={local-id}/name={value-name}/: + get: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" responses: - 201: - description: "Object created" + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + put: tags: - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" responses: + 201: + description: "Object created" 400: description: "Internal error" 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/committed-information-rate/: - get: + description: "Object modified" + delete: tags: - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" + 204: + description: "Object deleted" + /data/context/name/: post: tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + - "tapi-common" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -2891,22 +3067,46 @@ paths: description: "Internal error" 409: description: "Object already exists" + /data/context/name={value-name}/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" put: tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + - "tapi-common" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - - name: "uuid" + - name: "value-name" in: "path" - description: "Id of connectivity-service" + description: "Id of name" required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -2916,12 +3116,15 @@ paths: description: "Object modified" delete: tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + - "tapi-common" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - - name: "uuid" + - name: "value-name" in: "path" - description: "Id of connectivity-service" + description: "Id of name" required: true type: "string" responses: @@ -2929,40 +3132,32 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/peak-burst-size/: + /data/context/notification-context/: get: tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" + - "tapi-notification" + summary: "returns tapi.notification.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: [] responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.notification.NotificationContext" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.notification.NotificationContext" 400: description: "Internal error" post: tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + - "tapi-notification" + summary: "creates tapi.notification.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.notification.NotificationContext.body-param" + description: "tapi.notification.NotificationContext to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.notification.NotificationContext" responses: 201: description: "Object created" @@ -2972,20 +3167,16 @@ paths: description: "Object already exists" put: tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + - "tapi-notification" + summary: "creates or updates tapi.notification.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.notification.NotificationContext.body-param" + description: "tapi.notification.NotificationContext to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.notification.NotificationContext" responses: 201: description: "Object created" @@ -2995,76 +3186,73 @@ paths: description: "Object modified" delete: tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" + - "tapi-notification" + summary: "removes tapi.notification.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: [] responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/peak-information-rate/: - get: + /data/context/notification-context/notif-subscription/: + post: tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" + - "tapi-notification" + summary: "creates tapi.notification.NotificationSubscriptionService" + description: "none" parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" + - in: "body" + name: "tapi.notification.NotificationSubscriptionService.body-param" + description: "tapi.notification.NotificationSubscriptionService to be added\ + \ to list" + required: false + schema: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + /data/context/notification-context/notif-subscription={uuid}/: + get: tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + - "tapi-notification" + summary: "returns tapi.notification.NotificationSubscriptionService" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" required: true type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.notification.NotificationSubscriptionService" + schema: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + - "tapi-notification" + summary: "creates or updates tapi.notification.NotificationSubscriptionService" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.notification.NotificationSubscriptionService.body-param" + description: "tapi.notification.NotificationSubscriptionService to be added\ + \ or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" responses: 201: description: "Object created" @@ -3074,12 +3262,13 @@ paths: description: "Object modified" delete: tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + - "tapi-notification" + summary: "removes tapi.notification.NotificationSubscriptionService" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" required: true type: "string" responses: @@ -3087,40 +3276,26 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/total-size/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/name/: post: tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + - "tapi-notification" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -3128,22 +3303,56 @@ paths: description: "Internal error" 409: description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + /data/context/notification-context/notif-subscription={uuid}/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -3153,12 +3362,20 @@ paths: description: "Object modified" delete: tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + - "tapi-notification" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" required: true type: "string" responses: @@ -3166,242 +3383,229 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/resilience-type/: + /data/context/notification-context/notif-subscription={uuid}/notification-channel/: get: tags: - - "tapi-connectivity" - description: "returns tapi.topology.ResilienceType" + - "tapi-notification" + summary: "returns tapi.notification.NotificationChannel" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" required: true type: "string" responses: 200: - description: "tapi.topology.ResilienceType" + description: "tapi.notification.NotificationChannel" schema: - $ref: "#/definitions/tapi.topology.ResilienceType" + $ref: "#/definitions/tapi.notification.NotificationChannel" 400: description: "Internal error" - post: + /data/context/notification-context/notif-subscription={uuid}/notification-channel/name={value-name}/: + get: tags: - - "tapi-connectivity" - description: "creates tapi.topology.ResilienceType" + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" required: true type: "string" - - in: "body" - name: "tapi.topology.ResilienceType.body-param" - description: "tapi.topology.ResilienceType to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.ResilienceType" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.topology.ResilienceType" - parameters: - - name: "uuid" + - name: "value-name" in: "path" - description: "Id of connectivity-service" + description: "Id of name" required: true type: "string" - - in: "body" - name: "tapi.topology.ResilienceType.body-param" - description: "tapi.topology.ResilienceType to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.ResilienceType" responses: - 201: - description: "Object created" + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/: + get: tags: - - "tapi-connectivity" - description: "removes tapi.topology.ResilienceType" + - "tapi-notification" + summary: "returns tapi.notification.Notification" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" required: true type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/risk-diversity-characteristic/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" + - name: "notification-uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notification" required: true type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" responses: - 201: - description: "Object created" + 200: + description: "tapi.notification.Notification" + schema: + $ref: "#/definitions/tapi.notification.Notification" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/risk-diversity-characteristic={risk-characteristic-name}/: + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/additional-info={value-name}/: get: tags: - - "tapi-connectivity" - description: "returns tapi.topology.RiskCharacteristic" + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" required: true type: "string" - - name: "risk-characteristic-name" + - name: "notification-uuid" in: "path" - description: "Id of risk-diversity-characteristic" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of additional-info" required: true type: "string" responses: 200: - description: "tapi.topology.RiskCharacteristic" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/changed-attributes={value-name}/: + get: tags: - - "tapi-connectivity" - description: "creates tapi.topology.RiskCharacteristic" + - "tapi-notification" + summary: "returns tapi.notification.NameAndValueChange" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" required: true type: "string" - - name: "risk-characteristic-name" + - name: "notification-uuid" in: "path" - description: "Id of risk-diversity-characteristic" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of changed-attributes" required: true type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" responses: - 201: - description: "Object created" + 200: + description: "tapi.notification.NameAndValueChange" + schema: + $ref: "#/definitions/tapi.notification.NameAndValueChange" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/name={value-name}/: + get: tags: - - "tapi-connectivity" - description: "creates or updates tapi.topology.RiskCharacteristic" + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" required: true type: "string" - - name: "risk-characteristic-name" + - name: "notification-uuid" in: "path" - description: "Id of risk-diversity-characteristic" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" required: true type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" responses: - 201: - description: "Object created" + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/target-object-name={value-name}/: + get: tags: - - "tapi-connectivity" - description: "removes tapi.topology.RiskCharacteristic" + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" required: true type: "string" - - name: "risk-characteristic-name" + - name: "notification-uuid" in: "path" - description: "Id of risk-diversity-characteristic" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of target-object-name" required: true type: "string" responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/schedule/: + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/: get: tags: - - "tapi-connectivity" - description: "returns tapi.common.TimeRange" + - "tapi-notification" + summary: "returns tapi.notification.SubscriptionFilter" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" required: true type: "string" responses: 200: - description: "tapi.common.TimeRange" + description: "tapi.notification.SubscriptionFilter" schema: - $ref: "#/definitions/tapi.common.TimeRange" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" 400: description: "Internal error" post: tags: - - "tapi-connectivity" - description: "creates tapi.common.TimeRange" + - "tapi-notification" + summary: "creates tapi.notification.SubscriptionFilter" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" required: true type: "string" - in: "body" - name: "tapi.common.TimeRange.body-param" - description: "tapi.common.TimeRange to be added to list" + name: "tapi.notification.SubscriptionFilter.body-param" + description: "tapi.notification.SubscriptionFilter to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.TimeRange" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" responses: 201: description: "Object created" @@ -3411,20 +3615,21 @@ paths: description: "Object already exists" put: tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.TimeRange" + - "tapi-notification" + summary: "creates or updates tapi.notification.SubscriptionFilter" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" required: true type: "string" - in: "body" - name: "tapi.common.TimeRange.body-param" - description: "tapi.common.TimeRange to be added or updated" + name: "tapi.notification.SubscriptionFilter.body-param" + description: "tapi.notification.SubscriptionFilter to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.TimeRange" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" responses: 201: description: "Object created" @@ -3434,12 +3639,13 @@ paths: description: "Object modified" delete: tags: - - "tapi-connectivity" - description: "removes tapi.common.TimeRange" + - "tapi-notification" + summary: "removes tapi.notification.SubscriptionFilter" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" required: true type: "string" responses: @@ -3447,12 +3653,20 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/name/: + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name/: post: tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" + - "tapi-notification" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" - in: "body" name: "tapi.common.NameAndValue.body-param" description: "tapi.common.NameAndValue to be added to list" @@ -3466,12 +3680,20 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/name={value-name}/: + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name={value-name}/: get: tags: - - "tapi-common" - description: "returns tapi.common.NameAndValue" + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" - name: "value-name" in: "path" description: "Id of name" @@ -3484,11 +3706,19 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: + put: tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" + - "tapi-notification" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" - name: "value-name" in: "path" description: "Id of name" @@ -3496,7 +3726,7 @@ paths: type: "string" - in: "body" name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: $ref: "#/definitions/tapi.common.NameAndValue" @@ -3505,70 +3735,175 @@ paths: description: "Object created" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + 204: + description: "Object modified" + delete: tags: - - "tapi-common" - description: "creates or updates tapi.common.NameAndValue" + - "tapi-notification" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" - name: "value-name" in: "path" description: "Id of name" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" responses: - 201: - description: "Object created" 400: description: "Internal error" 204: - description: "Object modified" - delete: + description: "Object deleted" + /data/context/notification-context/notification={uuid}/: + get: tags: - - "tapi-common" - description: "removes tapi.common.NameAndValue" + - "tapi-notification" + summary: "returns tapi.notification.Notification" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.Notification" + schema: + $ref: "#/definitions/tapi.notification.Notification" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/additional-info={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of additional-info" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/changed-attributes={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NameAndValueChange" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of changed-attributes" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.NameAndValueChange" + schema: + $ref: "#/definitions/tapi.notification.NameAndValueChange" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" - name: "value-name" in: "path" description: "Id of name" required: true type: "string" responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/: + /data/context/notification-context/notification={uuid}/target-object-name={value-name}/: get: tags: - "tapi-notification" - description: "returns tapi.notification.NotificationContext" + summary: "returns tapi.common.NameAndValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of target-object-name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/path-computation-context/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" parameters: [] responses: 200: - description: "tapi.notification.NotificationContext" + description: "tapi.path.computation.PathComputationContext" schema: - $ref: "#/definitions/tapi.notification.NotificationContext" + $ref: "#/definitions/tapi.path.computation.PathComputationContext" 400: description: "Internal error" post: tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationContext" + - "tapi-path-computation" + summary: "creates tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" parameters: - in: "body" - name: "tapi.notification.NotificationContext.body-param" - description: "tapi.notification.NotificationContext to be added to list" + name: "tapi.path.computation.PathComputationContext.body-param" + description: "tapi.path.computation.PathComputationContext to be added to\ + \ list" required: false schema: - $ref: "#/definitions/tapi.notification.NotificationContext" + $ref: "#/definitions/tapi.path.computation.PathComputationContext" responses: 201: description: "Object created" @@ -3578,15 +3913,17 @@ paths: description: "Object already exists" put: tags: - - "tapi-notification" - description: "creates or updates tapi.notification.NotificationContext" + - "tapi-path-computation" + summary: "creates or updates tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" parameters: - in: "body" - name: "tapi.notification.NotificationContext.body-param" - description: "tapi.notification.NotificationContext to be added or updated" + name: "tapi.path.computation.PathComputationContext.body-param" + description: "tapi.path.computation.PathComputationContext to be added or\ + \ updated" required: false schema: - $ref: "#/definitions/tapi.notification.NotificationContext" + $ref: "#/definitions/tapi.path.computation.PathComputationContext" responses: 201: description: "Object created" @@ -3596,27 +3933,29 @@ paths: description: "Object modified" delete: tags: - - "tapi-notification" - description: "removes tapi.notification.NotificationContext" + - "tapi-path-computation" + summary: "removes tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" parameters: [] responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/notification-context/notif-subscription/: + /data/context/path-computation-context/path-comp-service/: post: tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationSubscriptionService" + - "tapi-path-computation" + summary: "creates tapi.path.computation.PathComputationService" + description: "none" parameters: - in: "body" - name: "tapi.notification.NotificationSubscriptionService.body-param" - description: "tapi.notification.NotificationSubscriptionService to be added\ - \ to list" + name: "tapi.path.computation.PathComputationService.body-param" + description: "tapi.path.computation.PathComputationService to be added to\ + \ list" required: false schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + $ref: "#/definitions/tapi.path.computation.PathComputationService" responses: 201: description: "Object created" @@ -3624,155 +3963,211 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/: + /data/context/path-computation-context/path-comp-service={uuid}/: get: tags: - - "tapi-notification" - description: "returns tapi.notification.NotificationSubscriptionService" + - "tapi-path-computation" + summary: "returns tapi.path.computation.PathComputationService" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of path-comp-service" required: true type: "string" responses: 200: - description: "tapi.notification.NotificationSubscriptionService" + description: "tapi.path.computation.PathComputationService" schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + $ref: "#/definitions/tapi.path.computation.PathComputationService" 400: description: "Internal error" - post: + put: tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationSubscriptionService" + - "tapi-path-computation" + summary: "creates or updates tapi.path.computation.PathComputationService" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of path-comp-service" required: true type: "string" - in: "body" - name: "tapi.notification.NotificationSubscriptionService.body-param" - description: "tapi.notification.NotificationSubscriptionService to be added\ - \ to list" + name: "tapi.path.computation.PathComputationService.body-param" + description: "tapi.path.computation.PathComputationService to be added or\ + \ updated" required: false schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + $ref: "#/definitions/tapi.path.computation.PathComputationService" responses: 201: description: "Object created" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + 204: + description: "Object modified" + delete: tags: - - "tapi-notification" - description: "creates or updates tapi.notification.NotificationSubscriptionService" + - "tapi-path-computation" + summary: "removes tapi.path.computation.PathComputationService" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of path-comp-service" required: true type: "string" - - in: "body" - name: "tapi.notification.NotificationSubscriptionService.body-param" - description: "tapi.notification.NotificationSubscriptionService to be added\ - \ or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" responses: - 201: - description: "Object created" 400: description: "Internal error" 204: - description: "Object modified" - delete: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/end-point/: + post: tags: - - "tapi-notification" - description: "removes tapi.notification.NotificationSubscriptionService" + - "tapi-path-computation" + summary: "creates tapi.path.computation.PathServiceEndPoint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of path-comp-service" required: true type: "string" + - in: "body" + name: "tapi.path.computation.PathServiceEndPoint.body-param" + description: "tapi.path.computation.PathServiceEndPoint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" responses: + 201: + description: "Object created" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/name/: - post: + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/: + get: tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" + - "tapi-path-computation" + summary: "returns tapi.path.computation.PathServiceEndPoint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.path.computation.PathServiceEndPoint" + schema: + $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + 400: + description: "Internal error" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.path.computation.PathServiceEndPoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.path.computation.PathServiceEndPoint.body-param" + description: "tapi.path.computation.PathServiceEndPoint to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" responses: 201: description: "Object created" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/name={value-name}/: + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.path.computation.PathServiceEndPoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/: get: tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" + - "tapi-path-computation" + summary: "returns tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of path-comp-service" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of name" + description: "Id of end-point" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" post: tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" + - "tapi-path-computation" + summary: "creates tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of path-comp-service" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of name" + description: "Id of end-point" required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.common.Capacity.body-param" + description: "tapi.common.Capacity to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.common.Capacity" responses: 201: description: "Object created" @@ -3782,25 +4177,26 @@ paths: description: "Object already exists" put: tags: - - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" + - "tapi-path-computation" + summary: "creates or updates tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of path-comp-service" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of name" + description: "Id of end-point" required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" + name: "tapi.common.Capacity.body-param" + description: "tapi.common.Capacity to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.common.Capacity" responses: 201: description: "Object created" @@ -3810,17 +4206,18 @@ paths: description: "Object modified" delete: tags: - - "tapi-notification" - description: "removes tapi.common.NameAndValue" + - "tapi-path-computation" + summary: "removes tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of path-comp-service" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of name" + description: "Id of end-point" required: true type: "string" responses: @@ -3828,40 +4225,54 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/notification-channel/: + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/total-size/: get: tags: - - "tapi-notification" - description: "returns tapi.notification.NotificationChannel" + - "tapi-path-computation" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" required: true type: "string" responses: 200: - description: "tapi.notification.NotificationChannel" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" post: tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationChannel" + - "tapi-path-computation" + summary: "creates tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" required: true type: "string" - in: "body" - name: "tapi.notification.NotificationChannel.body-param" - description: "tapi.notification.NotificationChannel to be added to list" + name: "tapi.common.CapacityValue.body-param" + description: "tapi.common.CapacityValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" + $ref: "#/definitions/tapi.common.CapacityValue" responses: 201: description: "Object created" @@ -3871,20 +4282,27 @@ paths: description: "Object already exists" put: tags: - - "tapi-notification" - description: "creates or updates tapi.notification.NotificationChannel" + - "tapi-path-computation" + summary: "creates or updates tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" required: true type: "string" - in: "body" - name: "tapi.notification.NotificationChannel.body-param" - description: "tapi.notification.NotificationChannel to be added or updated" + name: "tapi.common.CapacityValue.body-param" + description: "tapi.common.CapacityValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" + $ref: "#/definitions/tapi.common.CapacityValue" responses: 201: description: "Object created" @@ -3894,12 +4312,19 @@ paths: description: "Object modified" delete: tags: - - "tapi-notification" - description: "removes tapi.notification.NotificationChannel" + - "tapi-path-computation" + summary: "removes tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" required: true type: "string" responses: @@ -3907,15 +4332,23 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/notification-channel/name/: + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/name/: post: tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" + - "tapi-path-computation" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" required: true type: "string" - in: "body" @@ -3931,15 +4364,23 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/notification-channel/name={value-name}/: + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/name={value-name}/: get: tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" + - "tapi-path-computation" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" required: true type: "string" - name: "value-name" @@ -3954,42 +4395,22 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: + put: tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" + - "tapi-path-computation" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of path-comp-service" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" + - name: "local-id" in: "path" - description: "Id of notif-subscription" + description: "Id of end-point" required: true type: "string" - name: "value-name" @@ -4012,12 +4433,20 @@ paths: description: "Object modified" delete: tags: - - "tapi-notification" - description: "removes tapi.common.NameAndValue" + - "tapi-path-computation" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" required: true type: "string" - name: "value-name" @@ -4030,122 +4459,148 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/: + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/service-interface-point/: get: tags: - - "tapi-notification" - description: "returns tapi.notification.Notification" + - "tapi-path-computation" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of path-comp-service" required: true type: "string" - - name: "notification-uuid" + - name: "local-id" in: "path" - description: "Id of notification" + description: "Id of end-point" required: true type: "string" responses: 200: - description: "tapi.notification.Notification" + description: "tapi.common.ServiceInterfacePointRef" schema: - $ref: "#/definitions/tapi.notification.Notification" + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" 400: description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/additional-info={value-name}/: - get: + post: tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" + - "tapi-path-computation" + summary: "creates tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" + description: "Id of path-comp-service" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of additional-info" + description: "Id of end-point" required: true type: "string" + - in: "body" + name: "tapi.common.ServiceInterfacePointRef.body-param" + description: "tapi.common.ServiceInterfacePointRef to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/alarm-info/: - get: + 409: + description: "Object already exists" + put: tags: - - "tapi-notification" - description: "returns tapi.notification.AlarmInfo" + - "tapi-path-computation" + summary: "creates or updates tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of path-comp-service" required: true type: "string" - - name: "notification-uuid" + - name: "local-id" in: "path" - description: "Id of notification" + description: "Id of end-point" required: true type: "string" + - in: "body" + name: "tapi.common.ServiceInterfacePointRef.body-param" + description: "tapi.common.ServiceInterfacePointRef to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" responses: - 200: - description: "tapi.notification.AlarmInfo" - schema: - $ref: "#/definitions/tapi.notification.AlarmInfo" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/changed-attributes={value-name}/: - get: + 204: + description: "Object modified" + delete: tags: - - "tapi-notification" - description: "returns tapi.notification.NameAndValueChange" + - "tapi-path-computation" + summary: "removes tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of path-comp-service" required: true type: "string" - - name: "notification-uuid" + - name: "local-id" in: "path" - description: "Id of notification" + description: "Id of end-point" required: true type: "string" - - name: "value-name" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/name/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" in: "path" - description: "Id of changed-attributes" + description: "Id of path-comp-service" required: true type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" responses: - 200: - description: "tapi.notification.NameAndValueChange" - schema: - $ref: "#/definitions/tapi.notification.NameAndValueChange" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/name={value-name}/: + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/name={value-name}/: get: tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" + - "tapi-path-computation" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" + description: "Id of path-comp-service" required: true type: "string" - name: "value-name" @@ -4160,91 +4615,96 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/target-object-name={value-name}/: - get: + put: tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" + - "tapi-path-computation" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" + description: "Id of path-comp-service" required: true type: "string" - name: "value-name" in: "path" - description: "Id of target-object-name" + description: "Id of name" required: true type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/tca-info/: - get: + 204: + description: "Object modified" + delete: tags: - - "tapi-notification" - description: "returns tapi.notification.TcaInfo" + - "tapi-path-computation" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of path-comp-service" required: true type: "string" - - name: "notification-uuid" + - name: "value-name" in: "path" - description: "Id of notification" + description: "Id of name" required: true type: "string" responses: - 200: - description: "tapi.notification.TcaInfo" - schema: - $ref: "#/definitions/tapi.notification.TcaInfo" 400: description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/subscription-filter/: + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/objective-function/: get: tags: - - "tapi-notification" - description: "returns tapi.notification.SubscriptionFilter" + - "tapi-path-computation" + summary: "returns tapi.path.computation.PathObjectiveFunction" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of path-comp-service" required: true type: "string" responses: 200: - description: "tapi.notification.SubscriptionFilter" + description: "tapi.path.computation.PathObjectiveFunction" schema: - $ref: "#/definitions/tapi.notification.SubscriptionFilter" + $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" 400: description: "Internal error" post: tags: - - "tapi-notification" - description: "creates tapi.notification.SubscriptionFilter" + - "tapi-path-computation" + summary: "creates tapi.path.computation.PathObjectiveFunction" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of path-comp-service" required: true type: "string" - in: "body" - name: "tapi.notification.SubscriptionFilter.body-param" - description: "tapi.notification.SubscriptionFilter to be added to list" + name: "tapi.path.computation.PathObjectiveFunction.body-param" + description: "tapi.path.computation.PathObjectiveFunction to be added to list" required: false schema: - $ref: "#/definitions/tapi.notification.SubscriptionFilter" + $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" responses: 201: description: "Object created" @@ -4254,20 +4714,21 @@ paths: description: "Object already exists" put: tags: - - "tapi-notification" - description: "creates or updates tapi.notification.SubscriptionFilter" + - "tapi-path-computation" + summary: "creates or updates tapi.path.computation.PathObjectiveFunction" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of path-comp-service" required: true type: "string" - in: "body" - name: "tapi.notification.SubscriptionFilter.body-param" - description: "tapi.notification.SubscriptionFilter to be added or updated" + name: "tapi.path.computation.PathObjectiveFunction.body-param" + description: "tapi.path.computation.PathObjectiveFunction to be added or updated" required: false schema: - $ref: "#/definitions/tapi.notification.SubscriptionFilter" + $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" responses: 201: description: "Object created" @@ -4277,12 +4738,13 @@ paths: description: "Object modified" delete: tags: - - "tapi-notification" - description: "removes tapi.notification.SubscriptionFilter" + - "tapi-path-computation" + summary: "removes tapi.path.computation.PathObjectiveFunction" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of path-comp-service" required: true type: "string" responses: @@ -4290,15 +4752,18 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name/: + /data/context/path-computation-context/path-comp-service={uuid}/objective-function/name/: post: tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" + - "tapi-path-computation" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of path-comp-service" required: true type: "string" - in: "body" @@ -4314,15 +4779,18 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name={value-name}/: + /data/context/path-computation-context/path-comp-service={uuid}/objective-function/name={value-name}/: get: tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" + - "tapi-path-computation" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of path-comp-service" required: true type: "string" - name: "value-name" @@ -4337,42 +4805,17 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" put: tags: - - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" + - "tapi-path-computation" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of path-comp-service" required: true type: "string" - name: "value-name" @@ -4395,12 +4838,15 @@ paths: description: "Object modified" delete: tags: - - "tapi-notification" - description: "removes tapi.common.NameAndValue" + - "tapi-path-computation" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of path-comp-service" required: true type: "string" - name: "value-name" @@ -4413,125 +4859,135 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/notification-context/notification={uuid}/: + /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/: get: tags: - - "tapi-notification" - description: "returns tapi.notification.Notification" + - "tapi-path-computation" + summary: "returns tapi.path.computation.PathOptimizationConstraint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notification" + description: "Id of path-comp-service" required: true type: "string" responses: 200: - description: "tapi.notification.Notification" + description: "tapi.path.computation.PathOptimizationConstraint" schema: - $ref: "#/definitions/tapi.notification.Notification" + $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" 400: description: "Internal error" - /data/context/notification-context/notification={uuid}/additional-info={value-name}/: - get: + post: tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: + - "tapi-path-computation" + summary: "creates tapi.path.computation.PathOptimizationConstraint" + description: "none" + parameters: - name: "uuid" in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of additional-info" + description: "Id of path-comp-service" required: true type: "string" + - in: "body" + name: "tapi.path.computation.PathOptimizationConstraint.body-param" + description: "tapi.path.computation.PathOptimizationConstraint to be added\ + \ to list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/notification-context/notification={uuid}/alarm-info/: - get: + 409: + description: "Object already exists" + put: tags: - - "tapi-notification" - description: "returns tapi.notification.AlarmInfo" + - "tapi-path-computation" + summary: "creates or updates tapi.path.computation.PathOptimizationConstraint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notification" + description: "Id of path-comp-service" required: true type: "string" + - in: "body" + name: "tapi.path.computation.PathOptimizationConstraint.body-param" + description: "tapi.path.computation.PathOptimizationConstraint to be added\ + \ or updated" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" responses: - 200: - description: "tapi.notification.AlarmInfo" - schema: - $ref: "#/definitions/tapi.notification.AlarmInfo" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/notification-context/notification={uuid}/changed-attributes={value-name}/: - get: + 204: + description: "Object modified" + delete: tags: - - "tapi-notification" - description: "returns tapi.notification.NameAndValueChange" + - "tapi-path-computation" + summary: "removes tapi.path.computation.PathOptimizationConstraint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of changed-attributes" + description: "Id of path-comp-service" required: true type: "string" responses: - 200: - description: "tapi.notification.NameAndValueChange" - schema: - $ref: "#/definitions/tapi.notification.NameAndValueChange" 400: description: "Internal error" - /data/context/notification-context/notification={uuid}/name={value-name}/: - get: + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name/: + post: tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" + - "tapi-path-computation" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of path-comp-service" required: true type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/notification-context/notification={uuid}/target-object-name={value-name}/: + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name={value-name}/: get: tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" + - "tapi-path-computation" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of notification" + description: "Id of path-comp-service" required: true type: "string" - name: "value-name" in: "path" - description: "Id of target-object-name" + description: "Id of name" required: true type: "string" responses: @@ -4541,68 +4997,30 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/notification-context/notification={uuid}/tca-info/: - get: + put: tags: - - "tapi-notification" - description: "returns tapi.notification.TcaInfo" + - "tapi-path-computation" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of notification" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" required: true type: "string" - responses: - 200: - description: "tapi.notification.TcaInfo" - schema: - $ref: "#/definitions/tapi.notification.TcaInfo" - 400: - description: "Internal error" - /data/context/path-computation-context/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathComputationContext" - parameters: [] - responses: - 200: - description: "tapi.path.computation.PathComputationContext" - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathComputationContext" - parameters: - - in: "body" - name: "tapi.path.computation.PathComputationContext.body-param" - description: "tapi.path.computation.PathComputationContext to be added to\ - \ list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathComputationContext" - parameters: - in: "body" - name: "tapi.path.computation.PathComputationContext.body-param" - description: "tapi.path.computation.PathComputationContext to be added or\ - \ updated" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.path.computation.PathComputationContext" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -4613,38 +5031,56 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.path.computation.PathComputationContext" - parameters: [] + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service/: - post: + /data/context/path-computation-context/path-comp-service={uuid}/path={path-uuid}/: + get: tags: - "tapi-path-computation" - description: "creates tapi.path.computation.PathComputationService" + summary: "returns tapi.path.computation.PathRef" + description: "none" parameters: - - in: "body" - name: "tapi.path.computation.PathComputationService.body-param" - description: "tapi.path.computation.PathComputationService to be added to\ - \ list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationService" + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "path-uuid" + in: "path" + description: "Id of path" + required: true + type: "string" responses: - 201: - description: "Object created" + 200: + description: "tapi.path.computation.PathRef" + schema: + $ref: "#/definitions/tapi.path.computation.PathRef" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/: + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/: get: tags: - "tapi-path-computation" - description: "returns tapi.path.computation.PathComputationService" + summary: "returns tapi.path.computation.RoutingConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -4653,15 +5089,16 @@ paths: type: "string" responses: 200: - description: "tapi.path.computation.PathComputationService" + description: "tapi.path.computation.RoutingConstraint" schema: - $ref: "#/definitions/tapi.path.computation.PathComputationService" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" 400: description: "Internal error" post: tags: - "tapi-path-computation" - description: "creates tapi.path.computation.PathComputationService" + summary: "creates tapi.path.computation.RoutingConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -4669,12 +5106,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.path.computation.PathComputationService.body-param" - description: "tapi.path.computation.PathComputationService to be added to\ - \ list" + name: "tapi.path.computation.RoutingConstraint.body-param" + description: "tapi.path.computation.RoutingConstraint to be added to list" required: false schema: - $ref: "#/definitions/tapi.path.computation.PathComputationService" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" responses: 201: description: "Object created" @@ -4685,7 +5121,8 @@ paths: put: tags: - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathComputationService" + summary: "creates or updates tapi.path.computation.RoutingConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -4693,12 +5130,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.path.computation.PathComputationService.body-param" - description: "tapi.path.computation.PathComputationService to be added or\ - \ updated" + name: "tapi.path.computation.RoutingConstraint.body-param" + description: "tapi.path.computation.RoutingConstraint to be added or updated" required: false schema: - $ref: "#/definitions/tapi.path.computation.PathComputationService" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" responses: 201: description: "Object created" @@ -4709,7 +5145,8 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.path.computation.PathComputationService" + summary: "removes tapi.path.computation.RoutingConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -4721,11 +5158,13 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point/: + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic/: post: tags: - "tapi-path-computation" - description: "creates tapi.path.computation.PathServiceEndPoint" + summary: "creates tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" @@ -4733,11 +5172,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.path.computation.PathServiceEndPoint.body-param" - description: "tapi.path.computation.PathServiceEndPoint to be added to list" + name: "tapi.topology.CostCharacteristic.body-param" + description: "tapi.topology.CostCharacteristic to be added to list" required: false schema: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + $ref: "#/definitions/tapi.topology.CostCharacteristic" responses: 201: description: "Object created" @@ -4745,78 +5184,54 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/: + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic={cost-name}/: get: tags: - "tapi-path-computation" - description: "returns tapi.path.computation.PathServiceEndPoint" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "cost-name" in: "path" - description: "Id of end-point" + description: "Id of cost-characteristic" required: true type: "string" responses: 200: - description: "tapi.path.computation.PathServiceEndPoint" + description: "tapi.topology.CostCharacteristic" schema: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + $ref: "#/definitions/tapi.topology.CostCharacteristic" 400: description: "Internal error" - post: + put: tags: - "tapi-path-computation" - description: "creates tapi.path.computation.PathServiceEndPoint" + summary: "creates or updates tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "cost-name" in: "path" - description: "Id of end-point" + description: "Id of cost-characteristic" required: true type: "string" - in: "body" - name: "tapi.path.computation.PathServiceEndPoint.body-param" - description: "tapi.path.computation.PathServiceEndPoint to be added to list" + name: "tapi.topology.CostCharacteristic.body-param" + description: "tapi.topology.CostCharacteristic to be added or updated" required: false schema: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathServiceEndPoint.body-param" - description: "tapi.path.computation.PathServiceEndPoint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + $ref: "#/definitions/tapi.topology.CostCharacteristic" responses: 201: description: "Object created" @@ -4827,16 +5242,18 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.path.computation.PathServiceEndPoint" + summary: "removes tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "cost-name" in: "path" - description: "Id of end-point" + description: "Id of cost-characteristic" required: true type: "string" responses: @@ -4844,78 +5261,80 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/: - get: + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/latency-characteristic/: + post: tags: - "tapi-path-computation" - description: "returns tapi.common.Capacity" + summary: "creates tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" + - in: "body" + name: "tapi.topology.LatencyCharacteristic.body-param" + description: "tapi.topology.LatencyCharacteristic to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + ? /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/ + : get: tags: - "tapi-path-computation" - description: "creates tapi.common.Capacity" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "traffic-property-name" in: "path" - description: "Id of end-point" + description: "Id of latency-characteristic" required: true type: "string" - - in: "body" - name: "tapi.common.Capacity.body-param" - description: "tapi.common.Capacity to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.Capacity" responses: - 201: - description: "Object created" + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.Capacity" + summary: "creates or updates tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "traffic-property-name" in: "path" - description: "Id of end-point" + description: "Id of latency-characteristic" required: true type: "string" - in: "body" - name: "tapi.common.Capacity.body-param" - description: "tapi.common.Capacity to be added or updated" + name: "tapi.topology.LatencyCharacteristic.body-param" + description: "tapi.topology.LatencyCharacteristic to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" responses: 201: description: "Object created" @@ -4926,16 +5345,18 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.common.Capacity" + summary: "removes tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "traffic-property-name" in: "path" - description: "Id of end-point" + description: "Id of latency-characteristic" required: true type: "string" responses: @@ -4943,78 +5364,77 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/: - get: + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/risk-diversity-characteristic/: + post: tags: - "tapi-path-computation" - description: "returns tapi.common.BandwidthProfile" + summary: "creates tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" + - in: "body" + name: "tapi.topology.RiskCharacteristic.body-param" + description: "tapi.topology.RiskCharacteristic to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + ? /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/ + : get: tags: - "tapi-path-computation" - description: "creates tapi.common.BandwidthProfile" + summary: "returns tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "risk-characteristic-name" in: "path" - description: "Id of end-point" + description: "Id of risk-diversity-characteristic" required: true type: "string" - - in: "body" - name: "tapi.common.BandwidthProfile.body-param" - description: "tapi.common.BandwidthProfile to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" responses: - 201: - description: "Object created" + 200: + description: "tapi.topology.RiskCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.BandwidthProfile" + summary: "creates or updates tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "risk-characteristic-name" in: "path" - description: "Id of end-point" + description: "Id of risk-diversity-characteristic" required: true type: "string" - in: "body" - name: "tapi.common.BandwidthProfile.body-param" - description: "tapi.common.BandwidthProfile to be added or updated" + name: "tapi.topology.RiskCharacteristic.body-param" + description: "tapi.topology.RiskCharacteristic to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.topology.RiskCharacteristic" responses: 201: description: "Object created" @@ -5025,16 +5445,17 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.common.BandwidthProfile" + summary: "removes tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "risk-characteristic-name" in: "path" - description: "Id of end-point" + description: "Id of risk-diversity-characteristic" required: true type: "string" responses: @@ -5042,33 +5463,37 @@ paths: description: "Internal error" 204: description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-burst-size/ - : get: + /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/: + post: tags: - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" + summary: "creates tapi.path.computation.TopologyConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" + - in: "body" + name: "tapi.path.computation.TopologyConstraint.body-param" + description: "tapi.path.computation.TopologyConstraint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint={local-id}/: + get: tags: - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" + summary: "returns tapi.path.computation.TopologyConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -5077,26 +5502,21 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of topology-constraint" required: true type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.path.computation.TopologyConstraint" + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.path.computation.TopologyConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -5105,15 +5525,15 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of topology-constraint" required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.path.computation.TopologyConstraint.body-param" + description: "tapi.path.computation.TopologyConstraint to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" responses: 201: description: "Object created" @@ -5124,7 +5544,8 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.path.computation.TopologyConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -5133,7 +5554,7 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of topology-constraint" required: true type: "string" responses: @@ -5141,11 +5562,14 @@ paths: description: "Internal error" 204: description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-information-rate/ - : get: + /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint={local-id}/name/: + post: tags: - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -5154,20 +5578,30 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of topology-constraint" required: true type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint={local-id}/name={value-name}/: + get: tags: - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -5176,26 +5610,28 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" required: true type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -5204,15 +5640,20 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -5223,7 +5664,10 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -5232,7 +5676,12 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" required: true type: "string" responses: @@ -5240,149 +5689,186 @@ paths: description: "Internal error" 204: description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-burst-size/ - : get: + /data/context/path-computation-context/path={uuid}/: + get: tags: - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.path.computation.Path" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" + description: "Id of path" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.path.computation.Path" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.path.computation.Path" 400: description: "Internal error" - post: + /data/context/path-computation-context/path={uuid}/link={topology-uuid},{link-uuid}/: + get: tags: - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" + summary: "returns tapi.topology.LinkRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of path" required: true type: "string" - - name: "local-id" + - name: "topology-uuid" in: "path" - description: "Id of end-point" + description: "Id of link" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" required: true type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.topology.LinkRef" + schema: + $ref: "#/definitions/tapi.topology.LinkRef" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + /data/context/path-computation-context/path={uuid}/name={value-name}/: + get: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of path" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of end-point" + description: "Id of name" required: true type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + /data/context/path-computation-context/path={uuid}/routing-constraint/: + get: tags: - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" + summary: "returns tapi.path.computation.RoutingConstraint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of path" required: true type: "string" - - name: "local-id" + responses: + 200: + description: "tapi.path.computation.RoutingConstraint" + schema: + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + 400: + description: "Internal error" + /data/context/path-computation-context/path={uuid}/routing-constraint/cost-characteristic={cost-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" in: "path" - description: "Id of end-point" + description: "Id of path" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" required: true type: "string" responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" 400: description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-information-rate/ - : get: + /data/context/path-computation-context/path={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/: + get: tags: - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of path" required: true type: "string" - - name: "local-id" + - name: "traffic-property-name" in: "path" - description: "Id of end-point" + description: "Id of latency-characteristic" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.LatencyCharacteristic" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" - post: + /data/context/path-computation-context/path={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/: + get: tags: - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" + summary: "returns tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of path" required: true type: "string" - - name: "local-id" + - name: "risk-characteristic-name" in: "path" - description: "Id of end-point" + description: "Id of risk-diversity-characteristic" required: true type: "string" + responses: + 200: + description: "tapi.topology.RiskCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" + 400: + description: "Internal error" + /data/context/service-interface-point/: + post: + tags: + - "tapi-common" + summary: "creates tapi.common.ServiceInterfacePoint" + description: "none" + parameters: - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.common.ServiceInterfacePoint.body-param" + description: "tapi.common.ServiceInterfacePoint to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" responses: 201: description: "Object created" @@ -5390,27 +5876,42 @@ paths: description: "Internal error" 409: description: "Object already exists" - put: + /data/context/service-interface-point={uuid}/: + get: tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" + - "tapi-common" + summary: "returns tapi.common.ServiceInterfacePoint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of service-interface-point" required: true type: "string" - - name: "local-id" + responses: + 200: + description: "tapi.common.ServiceInterfacePoint" + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + 400: + description: "Internal error" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.ServiceInterfacePoint" + description: "none" + parameters: + - name: "uuid" in: "path" - description: "Id of end-point" + description: "Id of service-interface-point" required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.common.ServiceInterfacePoint.body-param" + description: "tapi.common.ServiceInterfacePoint to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" responses: 201: description: "Object created" @@ -5420,17 +5921,13 @@ paths: description: "Object modified" delete: tags: - - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" + - "tapi-common" + summary: "removes tapi.common.ServiceInterfacePoint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" + description: "Id of service-interface-point" required: true type: "string" responses: @@ -5438,20 +5935,36 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/total-size/: + /data/context/service-interface-point={uuid}/available-capacity/: get: tags: - - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" + - "tapi-common" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of service-interface-point" required: true type: "string" - - name: "local-id" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/service-interface-point={uuid}/available-capacity/total-size/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" in: "path" - description: "Id of end-point" + description: "Id of service-interface-point" required: true type: "string" responses: @@ -5461,27 +5974,26 @@ paths: $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" + /data/context/service-interface-point={uuid}/name/: post: tags: - - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" + - "tapi-common" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" + description: "Id of service-interface-point" required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -5489,27 +6001,56 @@ paths: description: "Internal error" 409: description: "Object already exists" + /data/context/service-interface-point={uuid}/name={value-name}/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" put: tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" + - "tapi-common" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of service-interface-point" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of end-point" + description: "Id of name" required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -5519,17 +6060,20 @@ paths: description: "Object modified" delete: tags: - - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" + - "tapi-common" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of service-interface-point" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of end-point" + description: "Id of name" required: true type: "string" responses: @@ -5537,89 +6081,72 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/name/: - post: + /data/context/service-interface-point={uuid}/total-potential-capacity/: + get: tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" + - "tapi-common" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" + description: "Id of service-interface-point" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/name={value-name}/: + /data/context/service-interface-point={uuid}/total-potential-capacity/total-size/: get: tags: - - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" + - "tapi-common" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of service-interface-point" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: [] + responses: + 200: + description: "tapi.topology.TopologyContext" + schema: + $ref: "#/definitions/tapi.topology.TopologyContext" 400: description: "Internal error" post: tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" + - "tapi-topology" + summary: "creates tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.topology.context.TopologyContext.body-param" + description: "tapi.topology.TopologyContext to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.topology.TopologyContext" responses: 201: description: "Object created" @@ -5629,30 +6156,16 @@ paths: description: "Object already exists" put: tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" + - "tapi-topology" + summary: "creates or updates tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" + name: "tapi.topology.context.TopologyContext.body-param" + description: "tapi.topology.TopologyContext to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.topology.TopologyContext" responses: 201: description: "Object created" @@ -5662,3393 +6175,161 @@ paths: description: "Object modified" delete: tags: - - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" + - "tapi-topology" + summary: "removes tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: [] responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/service-interface-point/: + /data/context/topology-context/nw-topology-service/: get: tags: - - "tapi-path-computation" - description: "returns tapi.common.ServiceInterfacePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" + - "tapi-topology" + summary: "returns tapi.topology.NetworkTopologyService" + description: "none" + parameters: [] responses: 200: - description: "tapi.common.ServiceInterfacePointRef" + description: "tapi.topology.NetworkTopologyService" schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + $ref: "#/definitions/tapi.topology.NetworkTopologyService" 400: description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/name/: - post: + /data/context/topology-context/nw-topology-service/name={value-name}/: + get: tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - - name: "uuid" + - name: "value-name" in: "path" - description: "Id of path-comp-service" + description: "Id of name" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/name={value-name}/: + /data/context/topology-context/nw-topology-service/topology={topology-uuid}/: get: tags: - - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" + - "tapi-topology" + summary: "returns tapi.topology.TopologyRef" + description: "none" parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" + - name: "topology-uuid" in: "path" - description: "Id of name" + description: "Id of topology" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.topology.TopologyRef" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.topology.TopologyRef" 400: description: "Internal error" - post: + /data/context/topology-context/topology={uuid}/: + get: tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" + - "tapi-topology" + summary: "returns tapi.topology.topologycontext.Topology" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of topology" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.topology.Topology" + schema: + $ref: "#/definitions/tapi.topology.Topology" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + /data/context/topology-context/topology={uuid}/boundary-node-edge-point={topology-uuid},{node-uuid},{node-edge-point-uuid}/: + get: tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of topology" required: true type: "string" - - name: "value-name" + - name: "topology-uuid" in: "path" - description: "Id of name" + description: "Id of boundary-node-edge-point" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" + - name: "node-uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of boundary-node-edge-point" required: true type: "string" - - name: "value-name" + - name: "node-edge-point-uuid" in: "path" - description: "Id of name" + description: "Id of boundary-node-edge-point" required: true type: "string" responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/objective-function/: + /data/context/topology-context/topology={uuid}/link={link-uuid}/: get: tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathObjectiveFunction" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathObjectiveFunction" - schema: - $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathObjectiveFunction" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathObjectiveFunction.body-param" - description: "tapi.path.computation.PathObjectiveFunction to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathObjectiveFunction" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathObjectiveFunction.body-param" - description: "tapi.path.computation.PathObjectiveFunction to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.PathObjectiveFunction" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/objective-function/name/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/objective-function/name={value-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathOptimizationConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathOptimizationConstraint" - schema: - $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathOptimizationConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathOptimizationConstraint.body-param" - description: "tapi.path.computation.PathOptimizationConstraint to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathOptimizationConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathOptimizationConstraint.body-param" - description: "tapi.path.computation.PathOptimizationConstraint to be added\ - \ or updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.PathOptimizationConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name={value-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/path={path-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "path-uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.RoutingConstraint" - schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.RoutingConstraint.body-param" - description: "tapi.path.computation.RoutingConstraint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.RoutingConstraint.body-param" - description: "tapi.path.computation.RoutingConstraint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/latency-characteristic/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - ? /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/ - : get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/risk-diversity-characteristic/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - ? /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/ - : get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.TopologyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.TopologyConstraint" - schema: - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.TopologyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.TopologyConstraint.body-param" - description: "tapi.path.computation.TopologyConstraint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.TopologyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.TopologyConstraint.body-param" - description: "tapi.path.computation.TopologyConstraint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.TopologyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/avoid-topology={topology-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of avoid-topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/exclude-link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LinkRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of exclude-link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of exclude-link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/exclude-node={topology-uuid},{node-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.NodeRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of exclude-node" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of exclude-node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/exclude-path={path-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "path-uuid" - in: "path" - description: "Id of exclude-path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LinkRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of include-link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-node={topology-uuid},{node-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.NodeRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-node" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of include-node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-path={path-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "path-uuid" - in: "path" - description: "Id of include-path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-topology={topology-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.Path" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.Path" - schema: - $ref: "#/definitions/tapi.path.computation.Path" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LinkRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/name={value-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/routing-constraint/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.RoutingConstraint" - schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/routing-constraint/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - /data/context/service-interface-point/: - post: - tags: - - "tapi-common" - description: "creates tapi.common.ServiceInterfacePoint" - parameters: - - in: "body" - name: "tapi.common.ServiceInterfacePoint.body-param" - description: "tapi.common.ServiceInterfacePoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/service-interface-point={uuid}/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.ServiceInterfacePoint" - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.ServiceInterfacePoint.body-param" - description: "tapi.common.ServiceInterfacePoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.ServiceInterfacePoint.body-param" - description: "tapi.common.ServiceInterfacePoint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/service-interface-point={uuid}/available-capacity/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/committed-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/total-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/name/: - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/service-interface-point={uuid}/name={value-name}/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/service-interface-point={uuid}/total-potential-capacity/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/total-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.TopologyContext" - parameters: [] - responses: - 200: - description: "tapi.topology.TopologyContext" - schema: - $ref: "#/definitions/tapi.topology.TopologyContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-topology" - description: "creates tapi.topology.TopologyContext" - parameters: - - in: "body" - name: "tapi.topology.context.TopologyContext.body-param" - description: "tapi.topology.TopologyContext to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.TopologyContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-topology" - description: "creates or updates tapi.topology.TopologyContext" - parameters: - - in: "body" - name: "tapi.topology.context.TopologyContext.body-param" - description: "tapi.topology.TopologyContext to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.TopologyContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-topology" - description: "removes tapi.topology.TopologyContext" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/topology-context/nw-topology-service/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NetworkTopologyService" - parameters: [] - responses: - 200: - description: "tapi.topology.NetworkTopologyService" - schema: - $ref: "#/definitions/tapi.topology.NetworkTopologyService" - 400: - description: "Internal error" - /data/context/topology-context/nw-topology-service/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/topology-context/nw-topology-service/topology={topology-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "topology-uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Topology" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Topology" - schema: - $ref: "#/definitions/tapi.topology.Topology" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Link" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Link" - schema: - $ref: "#/definitions/tapi.topology.Link" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/latency-characteristic={traffic-property-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/node-edge-point={topology-uuid},{node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/resilience-type/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.ResilienceType" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.ResilienceType" - schema: - $ref: "#/definitions/tapi.topology.ResilienceType" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/risk-characteristic={risk-characteristic-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/validation-mechanism={validation-mechanism}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.ValidationMechanism" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "validation-mechanism" - in: "path" - description: "Id of validation-mechanism" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.ValidationMechanism" - schema: - $ref: "#/definitions/tapi.topology.ValidationMechanism" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.topology.Node" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.topology.Node" - schema: - $ref: "#/definitions/tapi.topology.topology.Node" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "aggregated-node-edge-point-node-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/encap-topology/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/latency-characteristic={traffic-property-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroup" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRuleGroup" - schema: - $ref: "#/definitions/tapi.topology.NodeRuleGroup" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/composed-rule-group={topology-uuid},{composed-rule-group-node-uuid},{composed-rule-group-node-rule-group-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroupRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of composed-rule-group" - required: true - type: "string" - - name: "composed-rule-group-node-uuid" - in: "path" - description: "Id of composed-rule-group" - required: true - type: "string" - - name: "composed-rule-group-node-rule-group-uuid" - in: "path" - description: "Id of composed-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRuleGroupRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/cost-characteristic={cost-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.InterRuleGroup" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.InterRuleGroup" - schema: - $ref: "#/definitions/tapi.topology.InterRuleGroup" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/associated-node-rule-group={topology-uuid},{associated-node-rule-group-node-uuid},{associated-node-rule-group-node-rule-group-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroupRef" + - "tapi-topology" + summary: "returns tapi.topology.Link" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of associated-node-rule-group" - required: true - type: "string" - - name: "associated-node-rule-group-node-uuid" - in: "path" - description: "Id of associated-node-rule-group" - required: true - type: "string" - - name: "associated-node-rule-group-node-rule-group-uuid" + - name: "link-uuid" in: "path" - description: "Id of associated-node-rule-group" + description: "Id of link" required: true type: "string" responses: 200: - description: "tapi.topology.NodeRuleGroupRef" + description: "tapi.topology.Link" schema: - $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + $ref: "#/definitions/tapi.topology.Link" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/ - : get: + /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/: + get: tags: - "tapi-topology" - description: "returns tapi.common.Capacity" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" + - name: "link-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of link" required: true type: "string" responses: @@ -9058,304 +6339,283 @@ paths: $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/ - : get: + /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/total-size/: + get: tags: - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" + - name: "link-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of link" required: true type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ - : get: + /data/context/topology-context/topology={uuid}/link={link-uuid}/cost-characteristic={cost-name}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" + - name: "link-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of link" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "cost-name" in: "path" - description: "Id of inter-rule-group" + description: "Id of cost-characteristic" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.CostCharacteristic" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.CostCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: + /data/context/topology-context/topology={uuid}/link={link-uuid}/latency-characteristic={traffic-property-name}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" + - name: "link-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of link" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "traffic-property-name" in: "path" - description: "Id of inter-rule-group" + description: "Id of latency-characteristic" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.LatencyCharacteristic" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ - : get: + /data/context/topology-context/topology={uuid}/link={link-uuid}/name={value-name}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" + - name: "link-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of link" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "value-name" in: "path" - description: "Id of inter-rule-group" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ + ? /data/context/topology-context/topology={uuid}/link={link-uuid}/node-edge-point={topology-uuid},{node-uuid},{node-edge-point-uuid}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "node-uuid" + - name: "link-uuid" in: "path" - description: "Id of node" + description: "Id of link" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "topology-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "node-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.NodeEdgePointRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/total-size/ - : get: + /data/context/topology-context/topology={uuid}/link={link-uuid}/risk-characteristic={risk-characteristic-name}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" + - name: "link-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of link" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "risk-characteristic-name" in: "path" - description: "Id of inter-rule-group" + description: "Id of risk-characteristic" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.RiskCharacteristic" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.RiskCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/cost-characteristic={cost-name}/ - : get: + /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/: + get: tags: - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "cost-name" + - name: "link-uuid" in: "path" - description: "Id of cost-characteristic" + description: "Id of link" required: true type: "string" responses: 200: - description: "tapi.topology.CostCharacteristic" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/latency-characteristic={traffic-property-name}/ - : get: + /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/total-size/: + get: tags: - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "traffic-property-name" + - name: "link-uuid" in: "path" - description: "Id of latency-characteristic" + description: "Id of link" required: true type: "string" responses: 200: - description: "tapi.topology.LatencyCharacteristic" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/name={value-name}/ - : get: + /data/context/topology-context/topology={uuid}/link={link-uuid}/validation-mechanism={validation-mechanism}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.topology.ValidationMechanism" + description: "Provides details of the specific validation mechanism(s) used\ + \ to confirm the presence of an intended topologicalEntity." parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "node-uuid" + - name: "link-uuid" in: "path" - description: "Id of node" + description: "Id of link" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "validation-mechanism" in: "path" - description: "Id of node-rule-group" + description: "Id of validation-mechanism" required: true type: "string" - - name: "inter-rule-group-uuid" + responses: + 200: + description: "tapi.topology.ValidationMechanism" + schema: + $ref: "#/definitions/tapi.topology.ValidationMechanism" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of topology" required: true type: "string" - name: "value-name" @@ -9370,11 +6630,12 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/: + get: tags: - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" + summary: "returns tapi.topology.topology.Node" + description: "none" parameters: - name: "uuid" in: "path" @@ -9386,33 +6647,19 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-characteristic" - required: true - type: "string" responses: 200: - description: "tapi.topology.RiskCharacteristic" + description: "tapi.topology.topology.Node" schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" + $ref: "#/definitions/tapi.topology.topology.Node" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ : get: tags: - "tapi-topology" - description: "returns tapi.topology.Rule" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -9424,33 +6671,34 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "topology-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of aggregated-node-edge-point" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "aggregated-node-edge-point-node-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of aggregated-node-edge-point" required: true type: "string" - - name: "local-id" + - name: "node-edge-point-uuid" in: "path" - description: "Id of rule" + description: "Id of aggregated-node-edge-point" required: true type: "string" responses: 200: - description: "tapi.topology.Rule" + description: "tapi.topology.NodeEdgePointRef" schema: - $ref: "#/definitions/tapi.topology.Rule" + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/name={value-name}/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/: + get: tags: - "tapi-topology" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" @@ -9462,38 +6710,45 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "local-id" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/total-size/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" in: "path" - description: "Id of rule" + description: "Id of topology" required: true type: "string" - - name: "value-name" + - name: "node-uuid" in: "path" - description: "Id of name" + description: "Id of node" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/cost-characteristic={cost-name}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.Capacity" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" @@ -9505,28 +6760,24 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" + - name: "cost-name" in: "path" - description: "Id of inter-rule-group" + description: "Id of cost-characteristic" required: true type: "string" responses: 200: - description: "tapi.common.Capacity" + description: "tapi.topology.CostCharacteristic" schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.topology.CostCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/encap-topology/: + get: tags: - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" + summary: "returns tapi.topology.TopologyRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -9538,28 +6789,51 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + responses: + 200: + description: "tapi.topology.TopologyRef" + schema: + $ref: "#/definitions/tapi.topology.TopologyRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/latency-characteristic={traffic-property-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of topology" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "node-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of node" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" required: true type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.topology.LatencyCharacteristic" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/name={value-name}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -9571,28 +6845,24 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" + - name: "value-name" in: "path" - description: "Id of inter-rule-group" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.node.NodeEdgePoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -9604,28 +6874,24 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.node.NodeEdgePoint" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.node.NodeEdgePoint" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{aggregated-node-edge-point-node-edge-point-uuid}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -9637,28 +6903,39 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "topology-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "aggregated-node-edge-point-node-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "aggregated-node-edge-point-node-edge-point-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.NodeEdgePointRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-capacity/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" @@ -9670,28 +6947,25 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/total-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-capacity/total-size/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -9703,14 +6977,9 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of node-edge-point" required: true type: "string" responses: @@ -9720,11 +6989,12 @@ paths: $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/latency-characteristic={traffic-property-name}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-cep-layer-protocol={layer-protocol-qualifier}/ : get: tags: - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" + summary: "returns tapi.topology.NepLayerProtocolCapability" + description: "none" parameters: - name: "uuid" in: "path" @@ -9736,28 +7006,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "traffic-property-name" + - name: "layer-protocol-qualifier" in: "path" - description: "Id of latency-characteristic" + description: "Id of available-cep-layer-protocol" required: true type: "string" responses: 200: - description: "tapi.topology.LatencyCharacteristic" + description: "tapi.topology.NepLayerProtocolCapability" schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + $ref: "#/definitions/tapi.topology.NepLayerProtocolCapability" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/name={value-name}/: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/: get: tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" + - "tapi-connectivity" + summary: "returns tapi.connectivity.CepList" + description: "none" parameters: - name: "uuid" in: "path" @@ -9769,28 +7040,24 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "value-name" + - name: "node-edge-point-uuid" in: "path" - description: "Id of name" + description: "Id of node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.connectivity.CepList" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.connectivity.CepList" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/node-edge-point={topology-uuid},{node-edge-point-node-uuid},{node-edge-point-uuid}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/ : get: tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" + - "tapi-connectivity" + summary: "returns tapi.connectivity.ConnectionEndPoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -9802,38 +7069,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-edge-point-node-uuid" + - name: "node-edge-point-uuid" in: "path" description: "Id of node-edge-point" required: true type: "string" - - name: "node-edge-point-uuid" + - name: "connection-end-point-uuid" in: "path" - description: "Id of node-edge-point" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.topology.NodeEdgePointRef" + description: "tapi.connectivity.ConnectionEndPoint" schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + $ref: "#/definitions/tapi.connectivity.ConnectionEndPoint" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/aggregated-connection-end-point={topology-uuid},{aggregated-connection-end-point-node-uuid},{aggregated-connection-end-point-node-edge-point-uuid},{aggregated-connection-end-point-connection-end-point-uuid}/ : get: tags: - - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" + - "tapi-connectivity" + summary: "returns tapi.connectivity.ConnectionEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -9845,28 +7103,49 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of aggregated-connection-end-point" + required: true + type: "string" + - name: "aggregated-connection-end-point-node-uuid" + in: "path" + description: "Id of aggregated-connection-end-point" + required: true + type: "string" + - name: "aggregated-connection-end-point-node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of aggregated-connection-end-point" required: true type: "string" - - name: "risk-characteristic-name" + - name: "aggregated-connection-end-point-connection-end-point-uuid" in: "path" - description: "Id of risk-characteristic" + description: "Id of aggregated-connection-end-point" required: true type: "string" responses: 200: - description: "tapi.topology.RiskCharacteristic" + description: "tapi.connectivity.ConnectionEndPointRef" schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" + $ref: "#/definitions/tapi.connectivity.ConnectionEndPointRef" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/: - get: + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/client-node-edge-point={topology-uuid},{client-node-edge-point-node-uuid},{client-node-edge-point-node-edge-point-uuid}/ + : get: tags: - - "tapi-topology" - description: "returns tapi.topology.Rule" + - "tapi-connectivity" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -9878,28 +7157,46 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "local-id" + - name: "connection-end-point-uuid" in: "path" - description: "Id of rule" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of client-node-edge-point" + required: true + type: "string" + - name: "client-node-edge-point-node-uuid" + in: "path" + description: "Id of client-node-edge-point" + required: true + type: "string" + - name: "client-node-edge-point-node-edge-point-uuid" + in: "path" + description: "Id of client-node-edge-point" required: true type: "string" responses: 200: - description: "tapi.topology.Rule" + description: "tapi.topology.NodeEdgePointRef" schema: - $ref: "#/definitions/tapi.topology.Rule" + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/name={value-name}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/name={value-name}/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" + - "tapi-connectivity" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -9911,14 +7208,14 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "local-id" + - name: "connection-end-point-uuid" in: "path" - description: "Id of rule" + description: "Id of connection-end-point" required: true type: "string" - name: "value-name" @@ -9933,11 +7230,12 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/parent-node-edge-point/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" + - "tapi-connectivity" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -9949,23 +7247,31 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.common.Capacity" + description: "tapi.topology.NodeEdgePointRef" schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/mapped-service-interface-point={service-interface-point-uuid}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "NodeEdgePoint mapped to more than ServiceInterfacePoint (slicing/virtualizing)\ + \ or a ServiceInterfacePoint mapped to more than one NodeEdgePoint (load balancing/Resilience)\ + \ should be considered experimental" parameters: - name: "uuid" in: "path" @@ -9977,23 +7283,31 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "service-interface-point-uuid" + in: "path" + description: "Id of mapped-service-interface-point" required: true type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.common.ServiceInterfacePointRef" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/name={value-name}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -10005,23 +7319,30 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/total-potential-capacity/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" @@ -10033,23 +7354,25 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/total-potential-capacity/total-size/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -10061,9 +7384,9 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" responses: @@ -10073,11 +7396,12 @@ paths: $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.NodeRuleGroup" + description: "none" parameters: - name: "uuid" in: "path" @@ -10096,16 +7420,17 @@ paths: type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.NodeRuleGroup" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.NodeRuleGroup" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/total-size/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" @@ -10124,16 +7449,18 @@ paths: type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/: - get: + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/total-size/ + : get: tags: - "tapi-topology" - description: "returns tapi.topology.node.OwnedNodeEdgePoint" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -10145,23 +7472,24 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-rule-group" required: true type: "string" responses: 200: - description: "tapi.topology.node.OwnedNodeEdgePoint" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.topology.node.OwnedNodeEdgePoint" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/composed-rule-group={topology-uuid},{composed-rule-group-node-uuid},{composed-rule-group-node-rule-group-uuid}/ : get: tags: - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" + summary: "returns tapi.topology.NodeRuleGroupRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -10173,38 +7501,40 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-rule-group" required: true type: "string" - name: "topology-uuid" in: "path" - description: "Id of aggregated-node-edge-point" + description: "Id of composed-rule-group" required: true type: "string" - - name: "aggregated-node-edge-point-node-uuid" + - name: "composed-rule-group-node-uuid" in: "path" - description: "Id of aggregated-node-edge-point" + description: "Id of composed-rule-group" required: true type: "string" - - name: "node-edge-point-uuid" + - name: "composed-rule-group-node-rule-group-uuid" in: "path" - description: "Id of aggregated-node-edge-point" + description: "Id of composed-rule-group" required: true type: "string" responses: 200: - description: "tapi.topology.NodeEdgePointRef" + description: "tapi.topology.NodeRuleGroupRef" schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/cost-characteristic={cost-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.Capacity" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" @@ -10216,51 +7546,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of node" + description: "Id of node-rule-group" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "cost-name" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of cost-characteristic" required: true type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.topology.CostCharacteristic" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.topology.CostCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.InterRuleGroup" + description: "none" parameters: - name: "uuid" in: "path" @@ -10272,51 +7580,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of node" + description: "Id of node-rule-group" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of inter-rule-group" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.InterRuleGroup" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.InterRuleGroup" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/associated-node-rule-group={topology-uuid},{associated-node-rule-group-node-uuid},{associated-node-rule-group-node-rule-group-uuid}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.NodeRuleGroupRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -10328,79 +7614,44 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of node" + description: "Id of node-rule-group" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of inter-rule-group" required: true type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" + - name: "topology-uuid" in: "path" - description: "Id of topology" + description: "Id of associated-node-rule-group" required: true type: "string" - - name: "node-uuid" + - name: "associated-node-rule-group-node-uuid" in: "path" - description: "Id of node" + description: "Id of associated-node-rule-group" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "associated-node-rule-group-node-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of associated-node-rule-group" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.NodeRuleGroupRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/: - get: + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/ + : get: tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.CepList" + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" @@ -10412,23 +7663,30 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of inter-rule-group" required: true type: "string" responses: 200: - description: "tapi.connectivity.CepList" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.connectivity.CepList" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/total-size/ : get: tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionEndPoint" + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -10440,28 +7698,30 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-rule-group" required: true type: "string" - - name: "connection-end-point-uuid" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of connection-end-point" + description: "Id of inter-rule-group" required: true type: "string" responses: 200: - description: "tapi.connectivity.ConnectionEndPoint" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.connectivity.ConnectionEndPoint" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/aggregated-connection-end-point={topology-uuid},{aggregated-connection-end-point-node-uuid},{node-edge-point-uuid},{aggregated-connection-end-point-connection-end-point-uuid}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/cost-characteristic={cost-name}/ : get: tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionEndPointRef" + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" @@ -10473,48 +7733,35 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of aggregated-connection-end-point" - required: true - type: "string" - - name: "aggregated-connection-end-point-node-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of aggregated-connection-end-point" + description: "Id of node-rule-group" required: true type: "string" - - name: "node-edge-point-uuid" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of aggregated-connection-end-point" + description: "Id of inter-rule-group" required: true type: "string" - - name: "aggregated-connection-end-point-connection-end-point-uuid" + - name: "cost-name" in: "path" - description: "Id of aggregated-connection-end-point" + description: "Id of cost-characteristic" required: true type: "string" responses: 200: - description: "tapi.connectivity.ConnectionEndPointRef" + description: "tapi.topology.CostCharacteristic" schema: - $ref: "#/definitions/tapi.connectivity.ConnectionEndPointRef" + $ref: "#/definitions/tapi.topology.CostCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/client-node-edge-point={topology-uuid},{client-node-edge-point-node-uuid},{node-edge-point-uuid}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/latency-characteristic={traffic-property-name}/ : get: tags: - - "tapi-connectivity" - description: "returns tapi.topology.NodeEdgePointRef" + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" @@ -10526,43 +7773,36 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "topology-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of client-node-edge-point" + description: "Id of node-rule-group" required: true type: "string" - - name: "client-node-edge-point-node-uuid" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of client-node-edge-point" + description: "Id of inter-rule-group" required: true type: "string" - - name: "node-edge-point-uuid" + - name: "traffic-property-name" in: "path" - description: "Id of client-node-edge-point" + description: "Id of latency-characteristic" required: true type: "string" responses: 200: - description: "tapi.topology.NodeEdgePointRef" + description: "tapi.topology.LatencyCharacteristic" schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/name={value-name}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/name={value-name}/ : get: tags: - - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -10574,14 +7814,14 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-rule-group" required: true type: "string" - - name: "connection-end-point-uuid" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of connection-end-point" + description: "Id of inter-rule-group" required: true type: "string" - name: "value-name" @@ -10596,11 +7836,13 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/parent-node-edge-point/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ : get: tags: - - "tapi-connectivity" - description: "returns tapi.topology.NodeEdgePointRef" + - "tapi-topology" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." parameters: - name: "uuid" in: "path" @@ -10612,28 +7854,34 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-rule-group" required: true type: "string" - - name: "connection-end-point-uuid" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of connection-end-point" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-characteristic" required: true type: "string" responses: 200: - description: "tapi.topology.NodeEdgePointRef" + description: "tapi.topology.RiskCharacteristic" schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + $ref: "#/definitions/tapi.topology.RiskCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/mapped-service-interface-point={service-interface-point-uuid}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.ServiceInterfacePointRef" + summary: "returns tapi.topology.Rule" + description: "none" parameters: - name: "uuid" in: "path" @@ -10645,28 +7893,36 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-rule-group" required: true type: "string" - - name: "service-interface-point-uuid" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of mapped-service-interface-point" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" required: true type: "string" responses: 200: - description: "tapi.common.ServiceInterfacePointRef" + description: "tapi.topology.Rule" schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + $ref: "#/definitions/tapi.topology.Rule" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/name={value-name}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/name={value-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -10678,9 +7934,19 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "local-id" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of rule" required: true type: "string" - name: "value-name" @@ -10695,11 +7961,13 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/ : get: tags: - "tapi-topology" - description: "returns tapi.common.Capacity" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" @@ -10711,9 +7979,14 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of inter-rule-group" required: true type: "string" responses: @@ -10723,11 +7996,13 @@ paths: $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/total-size/ : get: tags: - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -10739,23 +8014,30 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of inter-rule-group" required: true type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/latency-characteristic={traffic-property-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" @@ -10767,23 +8049,31 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "traffic-property-name" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of latency-characteristic" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.LatencyCharacteristic" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/name={value-name}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -10795,23 +8085,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "value-name" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/node-edge-point={topology-uuid},{node-edge-point-node-uuid},{node-edge-point-uuid}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -10823,51 +8119,40 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-rule-group" required: true type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" + - name: "topology-uuid" in: "path" - description: "Id of topology" + description: "Id of node-edge-point" required: true type: "string" - - name: "node-uuid" + - name: "node-edge-point-node-uuid" in: "path" - description: "Id of node" + description: "Id of node-edge-point" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.NodeEdgePointRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/total-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." parameters: - name: "uuid" in: "path" @@ -10879,23 +8164,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "risk-characteristic-name" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of risk-characteristic" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.RiskCharacteristic" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.RiskCharacteristic" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/: get: tags: - "tapi-topology" - description: "returns tapi.common.Capacity" + summary: "returns tapi.topology.Rule" + description: "none" parameters: - name: "uuid" in: "path" @@ -10907,41 +8198,31 @@ paths: description: "Id of node" required: true type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of topology" + description: "Id of node-rule-group" required: true type: "string" - - name: "node-uuid" + - name: "local-id" in: "path" - description: "Id of node" + description: "Id of rule" required: true type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.topology.Rule" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.topology.Rule" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/name={value-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -10953,18 +8234,35 @@ paths: description: "Id of node" required: true type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" @@ -10976,18 +8274,25 @@ paths: description: "Id of node" required: true type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/total-size/ + : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -10999,6 +8304,11 @@ paths: description: "Id of node" required: true type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" responses: 200: description: "tapi.common.CapacityValue" @@ -11006,11 +8316,13 @@ paths: $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" @@ -11024,16 +8336,18 @@ paths: type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/total-size/: get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -11056,6 +8370,8 @@ paths: post: tags: - "tapi-path-computation" + summary: "operates on tapi.path.computation.ComputeP2PPath" + description: "operates on tapi.path.computation.ComputeP2PPath" parameters: - in: "body" name: "tapi.path.computation.computep2ppath.Input.body-param" @@ -11077,6 +8393,8 @@ paths: post: tags: - "tapi-connectivity" + summary: "operates on tapi.connectivity.CreateConnectivityService" + description: "operates on tapi.connectivity.CreateConnectivityService" parameters: - in: "body" name: "tapi.connectivity.createconnectivityservice.Input.body-param" @@ -11098,6 +8416,8 @@ paths: post: tags: - "tapi-notification" + summary: "operates on tapi.notification.CreateNotificationSubscriptionService" + description: "operates on tapi.notification.CreateNotificationSubscriptionService" parameters: - in: "body" name: "tapi.notification.createnotificationsubscriptionservice.Input.body-param" @@ -11119,6 +8439,8 @@ paths: post: tags: - "tapi-connectivity" + summary: "operates on tapi.connectivity.DeleteConnectivityService" + description: "operates on tapi.connectivity.DeleteConnectivityService" parameters: - in: "body" name: "tapi.connectivity.deleteconnectivityservice.Input.body-param" @@ -11136,6 +8458,8 @@ paths: post: tags: - "tapi-notification" + summary: "operates on tapi.notification.DeleteNotificationSubscriptionService" + description: "operates on tapi.notification.DeleteNotificationSubscriptionService" parameters: - in: "body" name: "tapi.notification.deletenotificationsubscriptionservice.Input.body-param" @@ -11145,10 +8469,6 @@ paths: input: $ref: "#/definitions/tapi.notification.deletenotificationsubscriptionservice.Input" responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.DeleteNotificationSubscriptionService" 201: description: "No response" 400: @@ -11157,6 +8477,8 @@ paths: post: tags: - "tapi-path-computation" + summary: "operates on tapi.path.computation.DeleteP2PPath" + description: "operates on tapi.path.computation.DeleteP2PPath" parameters: - in: "body" name: "tapi.path.computation.deletep2ppath.Input.body-param" @@ -11178,6 +8500,8 @@ paths: post: tags: - "tapi-connectivity" + summary: "operates on tapi.connectivity.GetConnectionDetails" + description: "operates on tapi.connectivity.GetConnectionDetails" parameters: - in: "body" name: "tapi.connectivity.getconnectiondetails.Input.body-param" @@ -11199,6 +8523,8 @@ paths: post: tags: - "tapi-connectivity" + summary: "operates on tapi.connectivity.GetConnectionEndPointDetails" + description: "operates on tapi.connectivity.GetConnectionEndPointDetails" parameters: - in: "body" name: "tapi.connectivity.getconnectionendpointdetails.Input.body-param" @@ -11220,6 +8546,8 @@ paths: post: tags: - "tapi-connectivity" + summary: "operates on tapi.connectivity.GetConnectivityServiceDetails" + description: "operates on tapi.connectivity.GetConnectivityServiceDetails" parameters: - in: "body" name: "tapi.connectivity.getconnectivityservicedetails.Input.body-param" @@ -11255,6 +8583,8 @@ paths: post: tags: - "tapi-topology" + summary: "operates on tapi.topology.GetLinkDetails" + description: "operates on tapi.topology.GetLinkDetails" parameters: - in: "body" name: "tapi.topology.getlinkdetails.Input.body-param" @@ -11276,6 +8606,8 @@ paths: post: tags: - "tapi-topology" + summary: "operates on tapi.topology.GetNodeDetails" + description: "operates on tapi.topology.GetNodeDetails" parameters: - in: "body" name: "tapi.topology.getnodedetails.Input.body-param" @@ -11297,6 +8629,8 @@ paths: post: tags: - "tapi-topology" + summary: "operates on tapi.topology.GetNodeEdgePointDetails" + description: "operates on tapi.topology.GetNodeEdgePointDetails" parameters: - in: "body" name: "tapi.topology.getnodeedgepointdetails.Input.body-param" @@ -11318,6 +8652,8 @@ paths: post: tags: - "tapi-notification" + summary: "operates on tapi.notification.GetNotificationList" + description: "operates on tapi.notification.GetNotificationList" parameters: - in: "body" name: "tapi.notification.getnotificationlist.Input.body-param" @@ -11339,6 +8675,8 @@ paths: post: tags: - "tapi-notification" + summary: "operates on tapi.notification.GetNotificationSubscriptionServiceDetails" + description: "operates on tapi.notification.GetNotificationSubscriptionServiceDetails" parameters: - in: "body" name: "tapi.notification.getnotificationsubscriptionservicedetails.Input.body-param" @@ -11374,6 +8712,8 @@ paths: post: tags: - "tapi-common" + summary: "operates on tapi.common.GetServiceInterfacePointDetails" + description: "operates on tapi.common.GetServiceInterfacePointDetails" parameters: - in: "body" name: "tapi.common.getserviceinterfacepointdetails.Input.body-param" @@ -11423,6 +8763,8 @@ paths: post: tags: - "tapi-topology" + summary: "operates on tapi.topology.GetTopologyDetails" + description: "operates on tapi.topology.GetTopologyDetails" parameters: - in: "body" name: "tapi.topology.gettopologydetails.Input.body-param" @@ -11458,6 +8800,8 @@ paths: post: tags: - "tapi-path-computation" + summary: "operates on tapi.path.computation.OptimizeP2PPath" + description: "operates on tapi.path.computation.OptimizeP2PPath" parameters: - in: "body" name: "tapi.path.computation.optimizep2ppath.Input.body-param" @@ -11479,6 +8823,8 @@ paths: post: tags: - "tapi-connectivity" + summary: "operates on tapi.connectivity.UpdateConnectivityService" + description: "operates on tapi.connectivity.UpdateConnectivityService" parameters: - in: "body" name: "tapi.connectivity.updateconnectivityservice.Input.body-param" @@ -11500,6 +8846,8 @@ paths: post: tags: - "tapi-notification" + summary: "operates on tapi.notification.UpdateNotificationSubscriptionService" + description: "operates on tapi.notification.UpdateNotificationSubscriptionService" parameters: - in: "body" name: "tapi.notification.updatenotificationsubscriptionservice.Input.body-param" @@ -11521,6 +8869,8 @@ paths: post: tags: - "tapi-common" + summary: "operates on tapi.common.UpdateServiceInterfacePoint" + description: "operates on tapi.common.UpdateServiceInterfacePoint" parameters: - in: "body" name: "tapi.common.updateserviceinterfacepoint.Input.body-param" @@ -11552,45 +8902,9 @@ definitions: enum: - "LOCKED" - "UNLOCKED" - tapi.common.BandwidthProfile: - type: "object" - properties: - committed-information-rate: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - coupling-flag: - type: "boolean" - description: "none" - default: false - bw-profile-type: - description: "none" - $ref: "#/definitions/tapi.common.BandwidthProfileType" - peak-information-rate: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - committed-burst-size: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - peak-burst-size: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - color-aware: - type: "boolean" - description: "none" - default: false - tapi.common.BandwidthProfileType: - type: "string" - enum: - - "MEF_10.x" - - "RFC_2697" - - "RFC_2698" - - "RFC_4115" tapi.common.Capacity: type: "object" properties: - bandwidth-profile: - description: "none" - $ref: "#/definitions/tapi.common.BandwidthProfile" total-size: description: "Total capacity of the TopologicalEntity in MB/s. In case of\ \ bandwidthProfile, this is expected to same as the committedInformationRate." @@ -11664,21 +8978,21 @@ definitions: properties: name: type: "array" - description: "List of names. A property of an entity with a value that is\ - \ unique in some namespace but may change during the life of the entity.\ - \ A name carries no semantics with respect to the purpose of the entity." + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." items: $ref: "#/definitions/tapi.common.NameAndValue" uuid: type: "string" description: "UUID: An identifier that is universally unique within an identifier\ - \ space, where the identifier space is itself globally unique, and immutable.\ - \ An UUID carries no semantics with respect to the purpose or state of the\ - \ entity.\r\n UUID here uses string representation as\ - \ defined in RFC 4122. The canonical representation uses lowercase characters.\r\ - \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ - \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ - \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a UUID\ + \ in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.common.LayerProtocolName: type: "string" enum: @@ -11699,9 +9013,9 @@ definitions: properties: name: type: "array" - description: "List of names. A property of an entity with a value that is\ - \ unique in some namespace but may change during the life of the entity.\ - \ A name carries no semantics with respect to the purpose of the entity." + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." items: $ref: "#/definitions/tapi.common.NameAndValue" local-id: @@ -11763,7 +9077,7 @@ definitions: $ref: "#/definitions/tapi.common.LayerProtocolName" description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ \ termination and adaptation functions of one or more transport layers. \r\ - \n The structure of LTP supports all transport protocols including\ + \n The structure of LTP supports all transport protocols including\ \ circuit and packet forms." tapi.common.ServiceInterfacePointRef: type: "object" @@ -11797,11 +9111,11 @@ definitions: type: "object" properties: termination-direction: - description: "The overall directionality of the LP. \r\n \ - \ - A BIDIRECTIONAL LP will have some SINK and/or SOURCE flowss.\r\n \ - \ - A SINK LP can only contain elements with SINK flows\ - \ or CONTRA_DIRECTION_SOURCE flows\r\n - A SOURCE LP\ - \ can only contain SOURCE flows or CONTRA_DIRECTION_SINK flows" + description: "The overall directionality of the LP. \r\n -\ + \ A BIDIRECTIONAL LP will have some SINK and/or SOURCE flowss.\r\n \ + \ - A SINK LP can only contain elements with SINK flows or CONTRA_DIRECTION_SOURCE\ + \ flows\r\n - A SOURCE LP can only contain SOURCE flows or\ + \ CONTRA_DIRECTION_SINK flows" $ref: "#/definitions/tapi.common.TerminationDirection" termination-state: description: "Indicates whether the layer is terminated and if so how." @@ -11828,9 +9142,16 @@ definitions: tapi.common.getserviceinterfacepointdetails.Input: type: "object" properties: - sip-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.common.getserviceinterfacepointdetails.Output: type: "object" properties: @@ -11848,9 +9169,16 @@ definitions: tapi.common.updateserviceinterfacepoint.Input: type: "object" properties: - sip-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" state: description: "none" $ref: "#/definitions/tapi.common.AdministrativeState" @@ -11878,11 +9206,11 @@ definitions: description: "An Connection object supports a recursive aggregation relationship\ \ such that the internal construction of an Connection can be exposed\ \ as multiple lower level Connection objects (partitioning).\r\n \ - \ Aggregation is used as for the Node/Topology to allow\ - \ changes in hierarchy. \r\n Connection aggregation\ - \ reflects Node/Topology aggregation. \r\n The FC represents\ - \ a Cross-Connection in an NE. The Cross-Connection in an NE is not necessarily\ - \ the lowest level of FC partitioning." + \ Aggregation is used as for the Node/Topology to allow changes\ + \ in hierarchy. \r\n Connection aggregation reflects Node/Topology\ + \ aggregation. \r\n The FC represents a Cross-Connection\ + \ in an NE. The Cross-Connection in an NE is not necessarily the lowest\ + \ level of FC partitioning." items: $ref: "#/definitions/tapi.connectivity.ConnectionRef" switch-control: @@ -11895,6 +9223,9 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.connectivity.Route" + bounding-node: + description: "none" + $ref: "#/definitions/tapi.topology.NodeRef" layer-protocol-name: description: "none" $ref: "#/definitions/tapi.common.LayerProtocolName" @@ -11908,9 +9239,8 @@ definitions: $ref: "#/definitions/tapi.common.ForwardingDirection" description: "The ForwardingConstruct (FC) object class models enabled potential\ \ for forwarding between two or more LTPs and like the LTP supports any transport\ - \ protocol including all circuit and packet forms.\r\n At the\ - \ lowest level of recursion, a FC represents a cross-connection within an\ - \ NE." + \ protocol including all circuit and packet forms.\r\n At the lowest\ + \ level of recursion, a FC represents a cross-connection within an NE." tapi.connectivity.ConnectionEndPoint: allOf: - $ref: "#/definitions/tapi.common.GlobalClass" @@ -11918,6 +9248,9 @@ definitions: - $ref: "#/definitions/tapi.common.TerminationPac" - type: "object" properties: + protection-role: + description: "none" + $ref: "#/definitions/tapi.connectivity.ProtectionRole" client-node-edge-point: type: "array" description: "none" @@ -11947,7 +9280,7 @@ definitions: $ref: "#/definitions/tapi.common.PortDirection" description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ \ termination and adaptation functions of one or more transport layers. \r\ - \n The structure of LTP supports all transport protocols including\ + \n The structure of LTP supports all transport protocols including\ \ circuit and packet forms." tapi.connectivity.ConnectionEndPointRef: allOf: @@ -11957,7 +9290,7 @@ definitions: connection-end-point-uuid: type: "string" description: "none" - x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:owned-node-edge-point/tapi-connectivity:cep-list/tapi-connectivity:connection-end-point/tapi-connectivity:uuid" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:node-edge-point/tapi-connectivity:cep-list/tapi-connectivity:connection-end-point/tapi-connectivity:uuid" description: "none" tapi.connectivity.ConnectionRef: type: "object" @@ -11969,15 +9302,9 @@ definitions: tapi.connectivity.ConnectivityConstraint: type: "object" properties: - service-layer: - description: "none" - $ref: "#/definitions/tapi.common.LayerProtocolName" schedule: description: "none" $ref: "#/definitions/tapi.common.TimeRange" - connectivity-direction: - description: "none" - $ref: "#/definitions/tapi.common.ForwardingDirection" requested-capacity: description: "none" $ref: "#/definitions/tapi.common.Capacity" @@ -11990,7 +9317,7 @@ definitions: type: "string" description: "An abstract value the meaning of which is mutually agreed \ \ typically represents metrics such as - Class of service, priority, resiliency,\ - \ availability" + \ availability\r\n Class of Service Name." service-type: description: "none" $ref: "#/definitions/tapi.connectivity.ServiceType" @@ -12014,27 +9341,42 @@ definitions: allOf: - $ref: "#/definitions/tapi.common.AdminStatePac" - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" - - $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" - - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - type: "object" properties: + topology-constraint: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" end-point: type: "array" description: "none" items: $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" + resilience-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" connection: type: "array" description: "none" items: $ref: "#/definitions/tapi.connectivity.ConnectionRef" + connectivity-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + direction: + description: "none" + $ref: "#/definitions/tapi.common.ForwardingDirection" description: "The ForwardingConstruct (FC) object class models enabled potential\ \ for forwarding between two or more LTPs and like the LTP supports any transport\ - \ protocol including all circuit and packet forms.\r\n At the\ - \ lowest level of recursion, a FC represents a cross-connection within an\ - \ NE." + \ protocol including all circuit and packet forms.\r\n At the lowest\ + \ level of recursion, a FC represents a cross-connection within an NE." tapi.connectivity.ConnectivityServiceEndPoint: allOf: - $ref: "#/definitions/tapi.common.AdminStatePac" @@ -12053,6 +9395,9 @@ definitions: service-interface-point: description: "none" $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + peer-fwd-connectivity-service-end-point: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" layer-protocol-name: description: "none" $ref: "#/definitions/tapi.common.LayerProtocolName" @@ -12064,23 +9409,39 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.connectivity.ConnectionEndPointRef" + server-connectivity-service-end-point: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" direction: description: "The orientation of defined flow at the EndPoint." $ref: "#/definitions/tapi.common.PortDirection" capacity: description: "none" $ref: "#/definitions/tapi.common.Capacity" + protecting-connectivity-service-end-point: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" description: "The association of the FC to LTPs is made via EndPoints.\r\n \ - \ The EndPoint (EP) object class models the access to the FC\ - \ function. \r\n The traffic forwarding between the associated\ - \ EPs of the FC depends upon the type of FC and may be associated with FcSwitch\ - \ object instances. \r\n In cases where there is resilience\ - \ the EndPoint may convey the resilience role of the access to the FC. \r\n\ - \ It can represent a protected (resilient/reliable) point or\ - \ a protecting (unreliable working or protection) point.\r\n \ - \ The EP replaces the Protection Unit of a traditional protection model.\ - \ \r\n The ForwadingConstruct can be considered as a component\ - \ and the EndPoint as a Port on that component" + \ The EndPoint (EP) object class models the access to the FC function.\ + \ \r\n The traffic forwarding between the associated EPs of the\ + \ FC depends upon the type of FC and may be associated with FcSwitch object\ + \ instances. \r\n In cases where there is resilience the EndPoint\ + \ may convey the resilience role of the access to the FC. \r\n \ + \ It can represent a protected (resilient/reliable) point or a protecting\ + \ (unreliable working or protection) point.\r\n The EP replaces\ + \ the Protection Unit of a traditional protection model. \r\n The\ + \ ForwadingConstruct can be considered as a component and the EndPoint as\ + \ a Port on that component" + tapi.connectivity.ConnectivityServiceEndPointRef: + allOf: + - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" + - type: "object" + properties: + connectivity-service-end-point-local-id: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-connectivity:connectivity-context/tapi-connectivity:connectivity-service/tapi-connectivity:end-point/tapi-connectivity:local-id" + description: "none" tapi.connectivity.ConnectivityServiceRef: type: "object" properties: @@ -12128,7 +9489,7 @@ definitions: properties: output: $ref: "#/definitions/tapi.connectivity.getconnectivityservicelist.Output" - tapi.connectivity.OwnedNodeEdgePointAugmentation1: + tapi.connectivity.NodeEdgePointAugmentation1: type: "object" properties: cep-list: @@ -12152,40 +9513,26 @@ definitions: is-lock-out: type: "boolean" description: "The resource is configured to temporarily not be available for\ - \ use in the protection scheme(s) it is part of.\r\n \ - \ This overrides all other protection control states including forced.\r\ - \n If the item is locked out then it cannot be used under\ - \ any circumstances.\r\n Note: Only relevant when part\ - \ of a protection scheme." + \ use in the protection scheme(s) it is part of.\r\n This\ + \ overrides all other protection control states including forced.\r\n \ + \ If the item is locked out then it cannot be used under any\ + \ circumstances.\r\n Note: Only relevant when part of a protection\ + \ scheme." default: false max-switch-times: type: "integer" format: "int32" description: "Used to limit the maximum swtich times. When work fault disappears\ \ , and traffic return to the original work path, switch counter reset." - restoration-coordinate-type: - description: " The coordination mechanism between multi-layers." - $ref: "#/definitions/tapi.connectivity.CoordinateType" - is-coordinated-switching-both-ends: - type: "boolean" - description: "Is operating such that switching at both ends of each flow acorss\ - \ the FC is coordinated at both ingress and egress ends." - default: false + protection-type: + description: "none" + $ref: "#/definitions/tapi.topology.ProtectionType" hold-off-time: type: "integer" format: "int32" description: "This attribute indicates the time, in milliseconds, between\ \ declaration of signal degrade or signal fail, and the initialization of\ \ the protection switching algorithm." - is-frozen: - type: "boolean" - description: "Temporarily prevents any switch action to be taken and, as such,\ - \ freezes the current state. \r\n Until the freeze is\ - \ cleared, additional near-end external commands are rejected and fault\ - \ condition changes and received APS messages are ignored.\r\n \ - \ All administrative controls of any aspect of protection are\ - \ rejected." - default: false wait-to-revert-time: type: "integer" format: "int32" @@ -12193,9 +9540,9 @@ definitions: \ the time, in minutes, to wait after a fault clears on a higher priority\ \ (preferred) resource before reverting to the preferred resource." default: 15 - resilience-type: - description: "none" - $ref: "#/definitions/tapi.topology.ResilienceType" + selection-control: + description: "Degree of administrative control applied to the switch selection." + $ref: "#/definitions/tapi.connectivity.SelectionControl" preferred-restoration-layer: type: "array" description: "Indicate which layer this resilience parameters package configured\ @@ -12206,6 +9553,28 @@ definitions: type: "integer" format: "int32" description: "none" + restoration-policy: + description: "none" + $ref: "#/definitions/tapi.topology.RestorationPolicy" + restoration-coordinate-type: + description: " The coordination mechanism between multi-layers." + $ref: "#/definitions/tapi.connectivity.CoordinateType" + is-coordinated-switching-both-ends: + type: "boolean" + description: "Is operating such that switching at both ends of each flow acorss\ + \ the FC is coordinated at both ingress and egress ends." + default: false + fault-condition-determination: + type: "string" + description: "none" + is-frozen: + type: "boolean" + description: "Temporarily prevents any switch action to be taken and, as such,\ + \ freezes the current state. \r\n Until the freeze is cleared,\ + \ additional near-end external commands are rejected and fault condition\ + \ changes and received APS messages are ignored.\r\n All\ + \ administrative controls of any aspect of protection are rejected." + default: false reversion-mode: description: "Indcates whether the protection scheme is revertive or non-revertive." $ref: "#/definitions/tapi.connectivity.ReversionMode" @@ -12225,9 +9594,9 @@ definitions: items: $ref: "#/definitions/tapi.connectivity.ConnectionEndPointRef" description: "The FC Route (FcRoute) object class models the individual routes\ - \ of an FC. \r\n The route of an FC object is represented by\ - \ a list of FCs at a lower level. \r\n Note that depending\ - \ on the service supported by an FC, an the FC can have multiple routes." + \ of an FC. \r\n The route of an FC object is represented by a\ + \ list of FCs at a lower level. \r\n Note that depending on the\ + \ service supported by an FC, an the FC can have multiple routes." tapi.connectivity.RouteRef: allOf: - $ref: "#/definitions/tapi.connectivity.ConnectionRef" @@ -12277,9 +9646,6 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.connectivity.RouteRef" - selection-control: - description: "Degree of administrative control applied to the switch selection." - $ref: "#/definitions/tapi.connectivity.SelectionControl" selection-reason: description: "The reason for the current switch selection." $ref: "#/definitions/tapi.connectivity.SelectionReason" @@ -12289,32 +9655,31 @@ definitions: $ref: "#/definitions/tapi.common.PortDirection" description: "The class models the switched forwarding of traffic (traffic flow)\ \ between FcPorts (ConnectionEndPoints) and is present where there is protection\ - \ functionality in the FC (Connection). \r\n If an FC exposes\ - \ protection (having two or more FcPorts that provide alternative identical\ - \ inputs/outputs), the FC will have one or more associated FcSwitch objects\ - \ to represent the alternative flow choices visible at the edge of the FC.\r\ - \n The FC switch represents and defines a protection switch\ - \ structure encapsulated in the FC. \r\n Essentially performs\ - \ one of the functions of the Protection Group in a traditional model. It\ - \ associates to 2 or more FcPorts each playing the role of a Protection Unit.\ - \ \r\n One or more protection, i.e. standby/backup, FcPorts\ - \ provide protection for one or more working (i.e. regular/main/preferred)\ - \ FcPorts where either protection or working can feed one or more protected\ - \ FcPort.\r\n The switch may be used in revertive or non-revertive\ - \ (symmetric) mode. When in revertive mode it may define a waitToRestore time.\r\ - \n It may be used in one of several modes including source\ - \ switch, destination switched, source and destination switched etc (covering\ - \ cases such as 1+1 and 1:1).\r\n It may be locked out (prevented\ - \ from switching), force switched or manual switched.\r\n It\ - \ will indicate switch state and change of state.\r\n The switch\ - \ can be switched away from all sources such that it becomes open and hence\ - \ two coordinated switches can both feed the same LTP so long as at least\ - \ one of the two is switched away from all sources (is 'open').\r\n \ - \ The ability for a Switch to be 'high impedance' allows bidirectional\ - \ ForwardingConstructs to be overlaid on the same bidirectional LTP where\ - \ the appropriate control is enabled to prevent signal conflict.\r\n \ - \ This ability allows multiple alternate routes to be present that\ - \ otherwise would be in conflict." + \ functionality in the FC (Connection). \r\n If an FC exposes protection\ + \ (having two or more FcPorts that provide alternative identical inputs/outputs),\ + \ the FC will have one or more associated FcSwitch objects to represent the\ + \ alternative flow choices visible at the edge of the FC.\r\n The\ + \ FC switch represents and defines a protection switch structure encapsulated\ + \ in the FC. \r\n Essentially performs one of the functions of\ + \ the Protection Group in a traditional model. It associates to 2 or more\ + \ FcPorts each playing the role of a Protection Unit. \r\n One\ + \ or more protection, i.e. standby/backup, FcPorts provide protection for\ + \ one or more working (i.e. regular/main/preferred) FcPorts where either protection\ + \ or working can feed one or more protected FcPort.\r\n The switch\ + \ may be used in revertive or non-revertive (symmetric) mode. When in revertive\ + \ mode it may define a waitToRestore time.\r\n It may be used in\ + \ one of several modes including source switch, destination switched, source\ + \ and destination switched etc (covering cases such as 1+1 and 1:1).\r\n \ + \ It may be locked out (prevented from switching), force switched\ + \ or manual switched.\r\n It will indicate switch state and change\ + \ of state.\r\n The switch can be switched away from all sources\ + \ such that it becomes open and hence two coordinated switches can both feed\ + \ the same LTP so long as at least one of the two is switched away from all\ + \ sources (is 'open').\r\n The ability for a Switch to be 'high\ + \ impedance' allows bidirectional ForwardingConstructs to be overlaid on the\ + \ same bidirectional LTP where the appropriate control is enabled to prevent\ + \ signal conflict.\r\n This ability allows multiple alternate routes\ + \ to be present that otherwise would be in conflict." tapi.connectivity.SwitchControl: allOf: - $ref: "#/definitions/tapi.common.GlobalClass" @@ -12353,8 +9718,10 @@ definitions: type: "object" properties: topology-constraint: + type: "array" description: "none" - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" end-point: type: "array" description: "none" @@ -12363,15 +9730,35 @@ definitions: resilience-constraint: description: "none" $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" routing-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.RoutingConstraint" state: - type: "string" description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" connectivity-constraint: description: "none" $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.connectivity.createconnectivityservice.Output: type: "object" properties: @@ -12381,15 +9768,29 @@ definitions: tapi.connectivity.deleteconnectivityservice.Input: type: "object" properties: - service-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.connectivity.getconnectiondetails.Input: type: "object" properties: - connection-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.connectivity.getconnectiondetails.Output: type: "object" properties: @@ -12399,18 +9800,16 @@ definitions: tapi.connectivity.getconnectionendpointdetails.Input: type: "object" properties: - cep-id-or-name: - type: "string" - description: "none" - nep-id-or-name: - type: "string" - description: "none" - node-id-or-name: - type: "string" - description: "none" - topology-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.connectivity.getconnectionendpointdetails.Output: type: "object" properties: @@ -12420,9 +9819,16 @@ definitions: tapi.connectivity.getconnectivityservicedetails.Input: type: "object" properties: - service-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.connectivity.getconnectivityservicedetails.Output: type: "object" properties: @@ -12440,12 +9846,11 @@ definitions: tapi.connectivity.updateconnectivityservice.Input: type: "object" properties: - service-id-or-name: - type: "string" - description: "none" topology-constraint: + type: "array" description: "none" - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" end-point: type: "array" description: "none" @@ -12454,37 +9859,38 @@ definitions: resilience-constraint: description: "none" $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" routing-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.RoutingConstraint" state: - type: "string" description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" connectivity-constraint: description: "none" $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.connectivity.updateconnectivityservice.Output: type: "object" properties: service: description: "none" $ref: "#/definitions/tapi.connectivity.ConnectivityService" - tapi.notification.AlarmInfo: - type: "object" - properties: - perceived-severity: - description: "none" - $ref: "#/definitions/tapi.notification.PerceivedSeverityType" - probable-cause: - type: "string" - description: "none" - service-affecting: - description: "none" - $ref: "#/definitions/tapi.notification.ServiceAffecting" - is-transient: - type: "boolean" - description: "none" - default: false tapi.notification.ContextAugmentation1: type: "object" properties: @@ -12499,11 +9905,6 @@ definitions: properties: output: $ref: "#/definitions/tapi.notification.createnotificationsubscriptionservice.Output" - tapi.notification.DeleteNotificationSubscriptionService: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.notification.deletenotificationsubscriptionservice.Output" tapi.notification.GetNotificationList: type: "object" properties: @@ -12542,8 +9943,8 @@ definitions: - type: "object" properties: target-object-type: + type: "string" description: "none" - $ref: "#/definitions/tapi.notification.ObjectType" additional-text: type: "string" description: "none" @@ -12559,18 +9960,15 @@ definitions: type: "integer" format: "int32" description: "A monotonous increasing sequence number associated with the\ - \ notification.\r\n The exact semantics of how this\ - \ sequence number is assigned (per channel or subscription or source or\ - \ system) is left undefined." - tca-info: - description: "none" - $ref: "#/definitions/tapi.notification.TcaInfo" + \ notification.\r\n The exact semantics of how this sequence\ + \ number is assigned (per channel or subscription or source or system)\ + \ is left undefined." target-object-identifier: type: "string" description: "none" notification-type: + type: "string" description: "none" - $ref: "#/definitions/tapi.notification.NotificationType" target-object-name: type: "array" description: "none" @@ -12582,9 +9980,9 @@ definitions: source-indicator: description: "none" $ref: "#/definitions/tapi.notification.SourceIndicator" - alarm-info: + layer-protocol-qualifier: + type: "string" description: "none" - $ref: "#/definitions/tapi.notification.AlarmInfo" changed-attributes: type: "array" description: "none" @@ -12604,9 +10002,9 @@ definitions: stream-address: type: "string" description: "The address/location/URI of the channel/stream to which the\ - \ subscribed notifications are published.\r\n This\ - \ specifics of this is typically dependent on the implementation protocol\ - \ & mechanism and hence is typed as a string." + \ subscribed notifications are published.\r\n This specifics\ + \ of this is typically dependent on the implementation protocol & mechanism\ + \ and hence is typed as a string." description: "none" tapi.notification.NotificationContext: type: "object" @@ -12641,68 +10039,16 @@ definitions: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.ObjectType" - supported-notification-types: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.NotificationType" - subscription-filter: - description: "none" - $ref: "#/definitions/tapi.notification.SubscriptionFilter" - description: "none" - tapi.notification.NotificationType: - type: "string" - enum: - - "OBJECT_CREATION" - - "OBJECT_DELETION" - - "ATTRIBUTE_VALUE_CHANGE" - - "ALARM_EVENT" - - "THRESHOLD_CROSSING_ALERT" - tapi.notification.ObjectType: - type: "string" - enum: - - "TOPOLOGY" - - "NODE" - - "LINK" - - "CONNECTION" - - "PATH" - - "CONNECTIVITY_SERVICE" - - "VIRTUAL_NETWORK_SERVICE" - - "PATH_COMPUTATION_SERVICE" - - "NODE_EDGE_POINT" - - "SERVICE_INTERFACE_POINT" - - "CONNECTION_END_POINT" - - "MAINTENANCE_ENTITY_GROUP" - - "MAINTENANCE_ENTITY" - - "MEG_END_POINT" - - "MEG_INTERMEDIATE_POINT" - - "SWITCH_CONTROL" - - "SWITCH" - - "ROUTE" - - "NODE_RULE_GROUP" - - "INTER_RULE_GROUP" - - "RULE" - - "OAM_JOB" - tapi.notification.PerceivedSeverityType: - type: "string" - enum: - - "CRITICAL" - - "MAJOR" - - "MINOR" - - "WARNING" - - "CLEARED" - tapi.notification.PerceivedTcaSeverity: - type: "string" - enum: - - "WARNING" - - "CLEAR" - tapi.notification.ServiceAffecting: - type: "string" - enum: - - "SERVICE_AFFECTING" - - "NOT_SERVICE_AFFECTING" - - "UNKNOWN" + type: "string" + supported-notification-types: + type: "array" + description: "none" + items: + type: "string" + subscription-filter: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + description: "none" tapi.notification.SourceIndicator: type: "string" enum: @@ -12718,7 +10064,7 @@ definitions: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.NotificationType" + type: "string" requested-object-identifier: type: "array" description: "none" @@ -12739,46 +10085,13 @@ definitions: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.ObjectType" + type: "string" description: "none" tapi.notification.SubscriptionState: type: "string" enum: - "SUSPENDED" - "ACTIVE" - tapi.notification.TcaInfo: - type: "object" - properties: - threshold-crossing: - description: "none" - $ref: "#/definitions/tapi.notification.ThresholdCrossingType" - threshold-parameter: - type: "string" - description: "none" - is-transient: - type: "boolean" - description: "none" - default: false - threshold-value: - type: "integer" - format: "int32" - description: "none" - perceived-severity: - description: "none" - $ref: "#/definitions/tapi.notification.PerceivedTcaSeverity" - suspect-interval-flag: - type: "boolean" - description: "none" - default: false - measurement-interval: - type: "string" - description: "none" - tapi.notification.ThresholdCrossingType: - type: "string" - enum: - - "THRESHOLD_ABOVE" - - "THRESHOLD_BELOW" - - "CLEARED" tapi.notification.UpdateNotificationSubscriptionService: type: "object" properties: @@ -12790,6 +10103,23 @@ definitions: subscription-state: description: "none" $ref: "#/definitions/tapi.notification.SubscriptionState" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" subscription-filter: description: "none" $ref: "#/definitions/tapi.notification.SubscriptionFilter" @@ -12802,24 +10132,33 @@ definitions: tapi.notification.deletenotificationsubscriptionservice.Input: type: "object" properties: - subscription-id-or-name: + uuid: type: "string" - description: "none" - tapi.notification.deletenotificationsubscriptionservice.Output: - type: "object" - properties: - subscription-service: - description: "none" - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.notification.getnotificationlist.Input: type: "object" properties: - time-period: - type: "string" - description: "none" - subscription-id-or-name: - type: "string" + time-range: description: "none" + $ref: "#/definitions/tapi.common.TimeRange" + subscription-id: + type: "string" + description: "UUID of the associated Notification Subscription Service: An\ + \ identifier that is universally unique within an identifier space, where\ + \ the identifier space is itself globally unique, and immutable.\r\n \ + \ An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.notification.getnotificationlist.Output: type: "object" properties: @@ -12831,9 +10170,16 @@ definitions: tapi.notification.getnotificationsubscriptionservicedetails.Input: type: "object" properties: - subscription-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.notification.getnotificationsubscriptionservicedetails.Output: type: "object" properties: @@ -12855,24 +10201,38 @@ definitions: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.ObjectType" + type: "string" supported-notification-types: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.NotificationType" + type: "string" tapi.notification.updatenotificationsubscriptionservice.Input: type: "object" properties: subscription-state: description: "none" $ref: "#/definitions/tapi.notification.SubscriptionState" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" subscription-filter: description: "none" $ref: "#/definitions/tapi.notification.SubscriptionFilter" - subscription-id-or-name: - type: "string" - description: "none" tapi.notification.updatenotificationsubscriptionservice.Output: type: "object" properties: @@ -12953,8 +10313,10 @@ definitions: - type: "object" properties: topology-constraint: + type: "array" description: "none" - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" path: type: "array" description: "none" @@ -12968,12 +10330,18 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" routing-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.RoutingConstraint" optimization-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" + direction: + description: "none" + $ref: "#/definitions/tapi.common.ForwardingDirection" description: "none" tapi.path.computation.PathObjectiveFunction: allOf: @@ -13038,16 +10406,16 @@ definitions: description: "none" $ref: "#/definitions/tapi.common.Capacity" description: "The association of the FC to LTPs is made via EndPoints.\r\n \ - \ The EndPoint (EP) object class models the access to the FC\ - \ function. \r\n The traffic forwarding between the associated\ - \ EPs of the FC depends upon the type of FC and may be associated with FcSwitch\ - \ object instances. \r\n In cases where there is resilience\ - \ the EndPoint may convey the resilience role of the access to the FC. \r\n\ - \ It can represent a protected (resilient/reliable) point or\ - \ a protecting (unreliable working or protection) point.\r\n \ - \ The EP replaces the Protection Unit of a traditional protection model.\ - \ \r\n The ForwadingConstruct can be considered as a component\ - \ and the EndPoint as a Port on that component" + \ The EndPoint (EP) object class models the access to the FC function.\ + \ \r\n The traffic forwarding between the associated EPs of the\ + \ FC depends upon the type of FC and may be associated with FcSwitch object\ + \ instances. \r\n In cases where there is resilience the EndPoint\ + \ may convey the resilience role of the access to the FC. \r\n \ + \ It can represent a protected (resilient/reliable) point or a protecting\ + \ (unreliable working or protection) point.\r\n The EP replaces\ + \ the Protection Unit of a traditional protection model. \r\n The\ + \ ForwadingConstruct can be considered as a component and the EndPoint as\ + \ a Port on that component" tapi.path.computation.RouteObjectiveFunction: type: "string" enum: @@ -13065,6 +10433,9 @@ definitions: type: "boolean" description: "To distinguish if the resources are to be exclusive to the service" default: true + tolerable-impact: + type: "string" + description: "Grades of maximum tolerable disruption to traffic." diversity-policy: description: "none" $ref: "#/definitions/tapi.path.computation.DiversityPolicy" @@ -13088,78 +10459,100 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.topology.RiskCharacteristic" - route-direction: - description: "none" - $ref: "#/definitions/tapi.common.ForwardingDirection" tapi.path.computation.TopologyConstraint: - type: "object" - properties: - include-node: - type: "array" - description: "This is a loose constraint - that is it is unordered and could\ - \ be a partial list" - items: - $ref: "#/definitions/tapi.topology.NodeRef" - exclude-link: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.LinkRef" - avoid-topology: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.TopologyRef" - exclude-path: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.path.computation.PathRef" - include-link: - type: "array" - description: "This is a loose constraint - that is it is unordered and could\ - \ be a partial list " - items: - $ref: "#/definitions/tapi.topology.LinkRef" - preferred-transport-layer: - type: "array" - description: "soft constraint requested by client to indicate the layer(s)\ - \ of transport connection that it prefers to carry the service. This could\ - \ be same as the service layer or one of the supported server layers" - items: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + include-node: + type: "string" + description: "This is a loose constraint - that is it is unordered and could\ + \ be a partial list" + exclude-link: + type: "string" + description: "none" + avoid-topology: + type: "string" + description: "none" + exclude-path: + type: "string" + description: "none" + include-topology: + type: "string" + description: "none" + include-path: + type: "string" + description: "none" + exclude-node-edge-point: + type: "string" + description: "none" + include-node-edge-point: + type: "string" + description: "none" + include-link: + type: "string" + description: "This is a loose constraint - that is it is unordered and could\ + \ be a partial list " + preferred-transport-layer: + description: "soft constraint requested by client to indicate the layer(s)\ + \ of transport connection that it prefers to carry the service. This could\ + \ be same as the service layer or one of the supported server layers" $ref: "#/definitions/tapi.common.LayerProtocolName" - exclude-node: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.NodeRef" - include-topology: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.TopologyRef" - include-path: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.path.computation.PathRef" + exclude-node: + type: "string" + description: "none" + constraint-weight: + type: "integer" + format: "int32" + description: "Zero and positive values: zero means 'strongly required to\ + \ be included', +1 means 'less strongly required to be included', etc.\r\ + \n For example the work/intended route will be calculated\ + \ considering the topologies which weights are lowest (but not negative).\r\ + \n Negative values: -1 means 'strongly required to be excluded',\ + \ -2 means 'less strongly required to be excluded', etc." + description: "The TopologyConstraint allows to specify topology entities in\ + \ order to impose specific constraints (as denoted by the attribute name)\ + \ on Connectivity/Path.\r\n The topology entities are specified\ + \ by their instance uuid rather than using references/path (to allow for mapping\ + \ to Yang 1.0).\r\n This loose typing and reference necessitates\ + \ that implementations validate not only the presence of the instance, but\ + \ also that it is of the correct type as implied by the attribute name.\r\n\ + \ If this validation fails, then the implementation is expceted\ + \ to return an error.\r\n " tapi.path.computation.computep2ppath.Input: type: "object" properties: topology-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - routing-constraint: + end-point: + type: "array" description: "none" - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + items: + $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" objective-function: description: "none" $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" - sep: + name: type: "array" - description: "none" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." items: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + $ref: "#/definitions/tapi.common.NameAndValue" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.path.computation.computep2ppath.Output: type: "object" properties: @@ -13169,9 +10562,16 @@ definitions: tapi.path.computation.deletep2ppath.Input: type: "object" properties: - path-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.path.computation.deletep2ppath.Output: type: "object" properties: @@ -13181,15 +10581,29 @@ definitions: tapi.path.computation.optimizep2ppath.Input: type: "object" properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" routing-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - path-id-or-name: - type: "string" - description: "none" optimization-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" objective-function: description: "none" $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" @@ -13285,7 +10699,7 @@ definitions: type: "string" description: "High frequency deviation from true periodicity of a signal and\ \ therefore a small high rate of change of transfer latency.\r\n \ - \ Applies to TDM systems (and not packet)." + \ Applies to TDM systems (and not packet)." fixed-latency-characteristic: type: "string" description: "A TopologicalEntity suffers delay caused by the realization\ @@ -13296,7 +10710,7 @@ definitions: type: "string" description: "Low frequency deviation from true periodicity of a signal and\ \ therefore a small low rate of change of transfer latency.\r\n \ - \ Applies to TDM systems (and not packet)." + \ Applies to TDM systems (and not packet)." queing-latency-characteristic: type: "string" description: "The specific queuing latency for the traffic property." @@ -13328,19 +10742,22 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.common.LayerProtocolName" - resilience-type: + restoration-policy: description: "none" - $ref: "#/definitions/tapi.topology.ResilienceType" + $ref: "#/definitions/tapi.topology.RestorationPolicy" node-edge-point: type: "array" description: "none" items: $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + protection-type: + description: "none" + $ref: "#/definitions/tapi.topology.ProtectionType" direction: - description: "The directionality of the Link. \r\n Is\ - \ applicable to simple Links where all LinkEnds are BIDIRECTIONAL (the\ - \ Link will be BIDIRECTIONAL) or UNIDIRECTIONAL (the Link will be UNIDIRECTIONAL).\ - \ \r\n Is not present in more complex cases." + description: "The directionality of the Link. \r\n Is applicable\ + \ to simple Links where all LinkEnds are BIDIRECTIONAL (the Link will\ + \ be BIDIRECTIONAL) or UNIDIRECTIONAL (the Link will be UNIDIRECTIONAL).\ + \ \r\n Is not present in more complex cases." $ref: "#/definitions/tapi.common.ForwardingDirection" description: "The Link object class models effective adjacency between two or\ \ more ForwardingDomains (FD). " @@ -13354,6 +10771,16 @@ definitions: description: "none" x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:link/tapi-topology:uuid" description: "none" + tapi.topology.NepLayerProtocolCapability: + type: "object" + properties: + layer-protocol-qualifier: + type: "string" + description: "none" + number-of-cep-instances: + type: "integer" + format: "int32" + description: "none" tapi.topology.NetworkTopologyService: allOf: - $ref: "#/definitions/tapi.common.GlobalClass" @@ -13383,16 +10810,16 @@ definitions: encap-topology: description: "none" $ref: "#/definitions/tapi.topology.TopologyRef" - owned-node-edge-point: + node-rule-group: type: "array" description: "none" items: - $ref: "#/definitions/tapi.topology.NodeEdgePoint" - node-rule-group: + $ref: "#/definitions/tapi.topology.NodeRuleGroup" + node-edge-point: type: "array" description: "none" items: - $ref: "#/definitions/tapi.topology.NodeRuleGroup" + $ref: "#/definitions/tapi.topology.NodeEdgePoint" aggregated-node-edge-point: type: "array" description: "none" @@ -13401,8 +10828,8 @@ definitions: description: "The ForwardingDomain (FD) object class models the ForwardingDomain\ \ topological component which is used to effect forwarding of transport characteristic\ \ information and offers the potential to enable forwarding. \r\n \ - \ At the lowest level of recursion, an FD (within a network element\ - \ (NE)) represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ + \ At the lowest level of recursion, an FD (within a network element (NE))\ + \ represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ \ multiple switch matrices (FDs). " tapi.topology.NodeEdgePoint: allOf: @@ -13424,6 +10851,11 @@ definitions: \ balancing/Resilience) should be considered experimental" items: $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + available-cep-layer-protocol: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NepLayerProtocolCapability" aggregated-node-edge-point: type: "array" description: "none" @@ -13435,14 +10867,9 @@ definitions: link-port-direction: description: "The orientation of defined flow at the LinkEnd." $ref: "#/definitions/tapi.common.PortDirection" - supported-cep-layer-protocol-qualifier: - type: "array" - description: "none" - items: - type: "string" description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ \ termination and adaptation functions of one or more transport layers. \r\ - \n The structure of LTP supports all transport protocols including\ + \n The structure of LTP supports all transport protocols including\ \ circuit and packet forms." tapi.topology.NodeEdgePointRef: allOf: @@ -13452,7 +10879,7 @@ definitions: node-edge-point-uuid: type: "string" description: "none" - x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:owned-node-edge-point/tapi-topology:uuid" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:node-edge-point/tapi-topology:uuid" description: "none" tapi.topology.NodeRef: allOf: @@ -13507,41 +10934,32 @@ definitions: tapi.topology.ProtectionType: type: "string" enum: - - "NO_PROTECTON" + - "NO_PROTECTION" - "ONE_PLUS_ONE_PROTECTION" - - "ONE_PLUS_ONE_PROTECTION_WITH_DYNAMIC_RESTORATION" - - "PERMANENT_ONE_PLUS_ONE_PROTECTION" - "ONE_FOR_ONE_PROTECTION" - - "DYNAMIC_RESTORATION" - - "PRE_COMPUTED_RESTORATION" - tapi.topology.ResilienceType: - type: "object" - properties: - restoration-policy: - description: "none" - $ref: "#/definitions/tapi.topology.RestorationPolicy" - protection-type: - description: "none" - $ref: "#/definitions/tapi.topology.ProtectionType" + - "ONE_FOR_N_PROTECTION" + - "M_FOR_N_PROTECTION" + - "ONE_FOR_ONE_BY_N" tapi.topology.RestorationPolicy: type: "string" enum: - "PER_DOMAIN_RESTORATION" - "END_TO_END_RESTORATION" - "NA" + - "DYNAMIC_RESTORATION" + - "PRE_COMPUTED_RESTORATION" tapi.topology.RiskCharacteristic: type: "object" properties: risk-characteristic-name: type: "string" description: "The name of the risk characteristic. The characteristic may\ - \ be related to a specific degree of closeness. \r\n \ - \ For example a particular characteristic may apply to failures that are\ - \ localized (e.g. to one side of a road) where as another characteristic\ - \ may relate to failures that have a broader impact (e.g. both sides of\ - \ a road that crosses a bridge).\r\n Depending upon the\ - \ importance of the traffic being routed different risk characteristics\ - \ will be evaluated." + \ be related to a specific degree of closeness. \r\n For\ + \ example a particular characteristic may apply to failures that are localized\ + \ (e.g. to one side of a road) where as another characteristic may relate\ + \ to failures that have a broader impact (e.g. both sides of a road that\ + \ crosses a bridge).\r\n Depending upon the importance of\ + \ the traffic being routed different risk characteristics will be evaluated." risk-identifier-list: type: "array" description: "A list of the identifiers of each physical/geographic unit (with\ @@ -13603,11 +11021,16 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.topology.Node" + boundary-node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" description: "The ForwardingDomain (FD) object class models the ForwardingDomain\ \ topological component which is used to effect forwarding of transport characteristic\ \ information and offers the potential to enable forwarding. \r\n \ - \ At the lowest level of recursion, an FD (within a network element\ - \ (NE)) represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ + \ At the lowest level of recursion, an FD (within a network element (NE))\ + \ represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ \ multiple switch matrices (FDs). " tapi.topology.TopologyContext: type: "object" @@ -13642,7 +11065,7 @@ definitions: error-characteristic: type: "string" description: "Describes the degree to which the signal propagated can be errored.\ - \ \r\n Applies to TDM systems as the errored signal will\ + \ \r\n Applies to TDM systems as the errored signal will\ \ be propagated and not packet as errored packets will be discarded." unavailable-time-characteristic: type: "string" @@ -13655,19 +11078,19 @@ definitions: delivery-order-characteristic: type: "string" description: "Describes the degree to which packets will be delivered out\ - \ of sequence.\r\n Does not apply to TDM as the TDM protocols\ + \ of sequence.\r\n Does not apply to TDM as the TDM protocols\ \ maintain strict order." repeat-delivery-characteristic: type: "string" description: "Primarily applies to packet systems where a packet may be delivered\ - \ more than once (in fault recovery for example). \r\n \ - \ It can also apply to TDM where several frames may be received twice\ - \ due to switching in a system with a large differential propagation delay." + \ more than once (in fault recovery for example). \r\n It\ + \ can also apply to TDM where several frames may be received twice due to\ + \ switching in a system with a large differential propagation delay." loss-characteristic: type: "string" description: "Describes the acceptable characteristic of lost packets where\ \ loss may result from discard due to errors or overflow.\r\n \ - \ Applies to packet systems and not TDM (as for TDM errored signals\ + \ Applies to packet systems and not TDM (as for TDM errored signals\ \ are propagated unless grossly errored and overflow/underflow turns into\ \ timing slips)." tapi.topology.TransferTimingPac: @@ -13704,12 +11127,27 @@ definitions: tapi.topology.getlinkdetails.Input: type: "object" properties: - link-id-or-name: + link-id: type: "string" - description: "none" - topology-id-or-name: - type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.topology.getlinkdetails.Output: type: "object" properties: @@ -13719,12 +11157,27 @@ definitions: tapi.topology.getnodedetails.Input: type: "object" properties: - node-id-or-name: - type: "string" - description: "none" - topology-id-or-name: - type: "string" - description: "none" + node-id: + type: "string" + description: "UUID of the Node: An identifier that is universally unique within\ + \ an identifier space, where the identifier space is itself globally unique,\ + \ and immutable.\r\n An UUID carries no semantics with\ + \ respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC 4122. The canonical\ + \ representation uses lowercase characters.\r\n Pattern:\ + \ [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\ + \ \r\n Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.topology.getnodedetails.Output: type: "object" properties: @@ -13734,15 +11187,37 @@ definitions: tapi.topology.getnodeedgepointdetails.Input: type: "object" properties: - ep-id-or-name: - type: "string" - description: "none" - node-id-or-name: - type: "string" - description: "none" - topology-id-or-name: + node-id: + type: "string" + description: "UUID of the parent Node: An identifier that is universally unique\ + \ within an identifier space, where the identifier space is itself globally\ + \ unique, and immutable.\r\n An UUID carries no semantics\ + \ with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC 4122. The\ + \ canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\ + \ \r\n Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Node's Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + node-edge-point-id: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.topology.getnodeedgepointdetails.Output: type: "object" properties: @@ -13752,9 +11227,16 @@ definitions: tapi.topology.gettopologydetails.Input: type: "object" properties: - topology-id-or-name: + topology-id: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.topology.gettopologydetails.Output: type: "object" properties: @@ -13769,9 +11251,9 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.topology.Topology" - tapi.topology.node.OwnedNodeEdgePoint: + tapi.topology.node.NodeEdgePoint: allOf: - - $ref: "#/definitions/tapi.connectivity.OwnedNodeEdgePointAugmentation1" + - $ref: "#/definitions/tapi.connectivity.NodeEdgePointAugmentation1" - $ref: "#/definitions/tapi.topology.NodeEdgePoint" tapi.topology.topology.Node: allOf: @@ -13791,16 +11273,16 @@ definitions: encap-topology: description: "none" $ref: "#/definitions/tapi.topology.TopologyRef" - owned-node-edge-point: + node-rule-group: type: "array" description: "none" items: - $ref: "#/definitions/tapi.topology.node.OwnedNodeEdgePoint" - node-rule-group: + $ref: "#/definitions/tapi.topology.NodeRuleGroup" + node-edge-point: type: "array" description: "none" items: - $ref: "#/definitions/tapi.topology.NodeRuleGroup" + $ref: "#/definitions/tapi.topology.node.NodeEdgePoint" aggregated-node-edge-point: type: "array" description: "none" diff --git a/OAS/tapi-oam@2018-12-10.yaml b/OAS/tapi-dsr@2019-03-31.yaml similarity index 68% rename from OAS/tapi-oam@2018-12-10.yaml rename to OAS/tapi-dsr@2019-03-31.yaml index b621980b..cfcc3400 100644 --- a/OAS/tapi-oam@2018-12-10.yaml +++ b/OAS/tapi-dsr@2019-03-31.yaml @@ -1,10 +1,121 @@ --- swagger: "2.0" info: - description: "tapi-oam,tapi-path-computation,tapi-connectivity,tapi-notification,tapi-topology,tapi-common\ - \ API generated from yang definitions" - version: "1.0" - title: "tapi-oam,tapi-path-computation,tapi-connectivity,tapi-notification,tapi-topology,tapi-common\ + description: "\r\n This module contains TAPI Notification Model definitions.\r\ + \n Source: TapiNotification.uml\r\n Copyright (c) 2018 Open Networking\ + \ Foundation (ONF). All rights reserved.\r\n License: This module is distributed\ + \ under the Apache License 2.0\r\n - The TAPI YANG models included in this\ + \ TAPI release are a *normative* part of the TAPI SDK.\r\n - The YANG specifications\ + \ have been generated from the corresponding UML model using the [ONF EAGLE UML2YANG\ + \ mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Topology\ + \ Model definitions.\r\n Source: TapiTopology.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI DSR Model\ + \ definitions.\r\n Source: TapiDsr.uml\r\n Copyright (c) 2018 Open\ + \ Networking Foundation (ONF). All rights reserved.\r\n License: This module\ + \ is distributed under the Apache License 2.0\r\n - The TAPI YANG models\ + \ included in this TAPI release are a *normative* part of the TAPI SDK.\r\n \ + \ - The YANG specifications have been generated from the corresponding UML\ + \ model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Common Model\ + \ definitions.\r\n Source: TapiCommon.uml\r\n Copyright (c) 2018\ + \ Open Networking Foundation (ONF). All rights reserved.\r\n License: This\ + \ module is distributed under the Apache License 2.0\r\n - The TAPI YANG\ + \ models included in this TAPI release are a *normative* part of the TAPI SDK.\r\ + \n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Path Computation\ + \ Model definitions.\r\n Source: TapiPathComputation.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Connectivity\ + \ Model definitions.\r\n Source: TapiConnectivity.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI OAM Model\ + \ definitions.\r\n Source: TapiOam.uml\r\n Copyright (c) 2018 Open\ + \ Networking Foundation (ONF). All rights reserved.\r\n License: This module\ + \ is distributed under the Apache License 2.0\r\n - The TAPI YANG models\ + \ included in this TAPI release are a *normative* part of the TAPI SDK.\r\n \ + \ - The YANG specifications have been generated from the corresponding UML\ + \ model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases." + version: "2.2.0" + title: "tapi-notification,tapi-topology,tapi-dsr,tapi-common,tapi-path-computation,tapi-connectivity,tapi-oam\ \ API" host: "localhost:1234" consumes: @@ -16,7 +127,8 @@ paths: get: tags: - "tapi-common" - description: "returns tapi.common.Context" + summary: "returns tapi.common.Context" + description: "none" parameters: [] responses: 200: @@ -28,7 +140,8 @@ paths: post: tags: - "tapi-common" - description: "creates tapi.common.Context" + summary: "creates tapi.common.Context" + description: "none" parameters: - in: "body" name: "tapi.common.Context.body-param" @@ -46,7 +159,8 @@ paths: put: tags: - "tapi-common" - description: "creates or updates tapi.common.Context" + summary: "creates or updates tapi.common.Context" + description: "none" parameters: - in: "body" name: "tapi.common.Context.body-param" @@ -64,7 +178,8 @@ paths: delete: tags: - "tapi-common" - description: "removes tapi.common.Context" + summary: "removes tapi.common.Context" + description: "none" parameters: [] responses: 400: @@ -75,7 +190,8 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityContext" + summary: "returns tapi.connectivity.ConnectivityContext" + description: "Augments the base TAPI Context with ConnectivityService information" parameters: [] responses: 200: @@ -87,7 +203,8 @@ paths: post: tags: - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityContext" + summary: "creates tapi.connectivity.ConnectivityContext" + description: "Augments the base TAPI Context with ConnectivityService information" parameters: - in: "body" name: "tapi.connectivity.ConnectivityContext.body-param" @@ -105,7 +222,8 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityContext" + summary: "creates or updates tapi.connectivity.ConnectivityContext" + description: "Augments the base TAPI Context with ConnectivityService information" parameters: - in: "body" name: "tapi.connectivity.ConnectivityContext.body-param" @@ -123,7 +241,8 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityContext" + summary: "removes tapi.connectivity.ConnectivityContext" + description: "Augments the base TAPI Context with ConnectivityService information" parameters: [] responses: 400: @@ -134,7 +253,8 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.Connection" + summary: "returns tapi.connectivity.Connection" + description: "none" parameters: - name: "uuid" in: "path" @@ -148,11 +268,31 @@ paths: $ref: "#/definitions/tapi.connectivity.Connection" 400: description: "Internal error" + /data/context/connectivity-context/connection={uuid}/bounding-node/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.topology.NodeRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connection" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeRef" + schema: + $ref: "#/definitions/tapi.topology.NodeRef" + 400: + description: "Internal error" ? /data/context/connectivity-context/connection={uuid}/connection-end-point={topology-uuid},{node-uuid},{node-edge-point-uuid},{connection-end-point-uuid}/ : get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionEndPointRef" + summary: "returns tapi.connectivity.ConnectionEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -190,7 +330,14 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionRef" + summary: "returns tapi.connectivity.ConnectionRef" + description: "An Connection object supports a recursive aggregation relationship\ + \ such that the internal construction of an Connection can be exposed as multiple\ + \ lower level Connection objects (partitioning).\r\n Aggregation\ + \ is used as for the Node/Topology to allow changes in hierarchy. \r\n \ + \ Connection aggregation reflects Node/Topology aggregation.\ + \ \r\n The FC represents a Cross-Connection in an NE. The Cross-Connection\ + \ in an NE is not necessarily the lowest level of FC partitioning." parameters: - name: "uuid" in: "path" @@ -213,7 +360,10 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -236,7 +386,8 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.Route" + summary: "returns tapi.connectivity.Route" + description: "none" parameters: - name: "uuid" in: "path" @@ -259,7 +410,8 @@ paths: : get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionEndPointRef" + summary: "returns tapi.connectivity.ConnectionEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -302,7 +454,10 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -330,7 +485,8 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.topology.LinkRef" + summary: "returns tapi.topology.LinkRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -358,7 +514,8 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.SwitchControl" + summary: "returns tapi.connectivity.SwitchControl" + description: "none" parameters: - name: "uuid" in: "path" @@ -381,7 +538,10 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -405,34 +565,12 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/resilience-type/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.ResilienceType" - parameters: - - name: "uuid" - in: "path" - description: "Id of connection" - required: true - type: "string" - - name: "switch-control-uuid" - in: "path" - description: "Id of switch-control" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.ResilienceType" - schema: - $ref: "#/definitions/tapi.topology.ResilienceType" - 400: - description: "Internal error" ? /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/sub-switch-control={connection-uuid},{sub-switch-control-switch-control-uuid}/ : get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.SwitchControlRef" + summary: "returns tapi.connectivity.SwitchControlRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -465,7 +603,8 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.Switch" + summary: "returns tapi.connectivity.Switch" + description: "none" parameters: - name: "uuid" in: "path" @@ -493,7 +632,10 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -526,7 +668,8 @@ paths: : get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionEndPointRef" + summary: "returns tapi.connectivity.ConnectionEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -574,7 +717,8 @@ paths: : get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.RouteRef" + summary: "returns tapi.connectivity.RouteRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -612,7 +756,8 @@ paths: post: tags: - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityService" + summary: "creates tapi.connectivity.ConnectivityService" + description: "none" parameters: - in: "body" name: "tapi.connectivity.ConnectivityService.body-param" @@ -631,7 +776,8 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityService" + summary: "returns tapi.connectivity.ConnectivityService" + description: "none" parameters: - name: "uuid" in: "path" @@ -645,33 +791,11 @@ paths: $ref: "#/definitions/tapi.connectivity.ConnectivityService" 400: description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityService" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.connectivity.ConnectivityService.body-param" - description: "tapi.connectivity.ConnectivityService to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityService" + summary: "creates or updates tapi.connectivity.ConnectivityService" + description: "none" parameters: - name: "uuid" in: "path" @@ -694,7 +818,8 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityService" + summary: "removes tapi.connectivity.ConnectivityService" + description: "none" parameters: - name: "uuid" in: "path" @@ -706,34 +831,12 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/avoid-topology={topology-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of avoid-topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" /data/context/connectivity-context/connectivity-service={uuid}/connection={connection-uuid}/: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionRef" + summary: "returns tapi.connectivity.ConnectionRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -752,11 +855,12 @@ paths: $ref: "#/definitions/tapi.connectivity.ConnectionRef" 400: description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/coroute-inclusion/: + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityServiceRef" + summary: "returns tapi.connectivity.ConnectivityConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -765,15 +869,16 @@ paths: type: "string" responses: 200: - description: "tapi.connectivity.ConnectivityServiceRef" + description: "tapi.connectivity.ConnectivityConstraint" schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" 400: description: "Internal error" post: tags: - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceRef" + summary: "creates tapi.connectivity.ConnectivityConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -781,11 +886,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.connectivity.ConnectivityServiceRef.body-param" - description: "tapi.connectivity.ConnectivityServiceRef to be added to list" + name: "tapi.connectivity.ConnectivityConstraint.body-param" + description: "tapi.connectivity.ConnectivityConstraint to be added to list" required: false schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" responses: 201: description: "Object created" @@ -796,7 +901,8 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityServiceRef" + summary: "creates or updates tapi.connectivity.ConnectivityConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -804,11 +910,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.connectivity.ConnectivityServiceRef.body-param" - description: "tapi.connectivity.ConnectivityServiceRef to be added or updated" + name: "tapi.connectivity.ConnectivityConstraint.body-param" + description: "tapi.connectivity.ConnectivityConstraint to be added or updated" required: false schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" responses: 201: description: "Object created" @@ -819,7 +925,8 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityServiceRef" + summary: "removes tapi.connectivity.ConnectivityConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -831,74 +938,42 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/cost-characteristic/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/cost-characteristic={cost-name}/: + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/coroute-inclusion/: get: tags: - "tapi-connectivity" - description: "returns tapi.topology.CostCharacteristic" + summary: "returns tapi.connectivity.ConnectivityServiceRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" responses: 200: - description: "tapi.topology.CostCharacteristic" + description: "tapi.connectivity.ConnectivityServiceRef" schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" 400: description: "Internal error" post: tags: - "tapi-connectivity" - description: "creates tapi.topology.CostCharacteristic" + summary: "creates tapi.connectivity.ConnectivityServiceRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" + name: "tapi.connectivity.ConnectivityServiceRef.body-param" + description: "tapi.connectivity.ConnectivityServiceRef to be added to list" required: false schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" responses: 201: description: "Object created" @@ -909,24 +984,20 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.topology.CostCharacteristic" + summary: "creates or updates tapi.connectivity.ConnectivityServiceRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added or updated" + name: "tapi.connectivity.ConnectivityServiceRef.body-param" + description: "tapi.connectivity.ConnectivityServiceRef to be added or updated" required: false schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" responses: 201: description: "Object created" @@ -937,28 +1008,25 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.topology.CostCharacteristic" + summary: "removes tapi.connectivity.ConnectivityServiceRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/diversity-exclusion/: + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/diversity-exclusion/: post: tags: - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceRef" + summary: "creates tapi.connectivity.ConnectivityServiceRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -978,11 +1046,12 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/diversity-exclusion={connectivity-service-uuid}/: - get: + ? /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/diversity-exclusion={connectivity-service-uuid}/ + : get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityServiceRef" + summary: "returns tapi.connectivity.ConnectivityServiceRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1001,10 +1070,11 @@ paths: $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" 400: description: "Internal error" - post: + put: tags: - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceRef" + summary: "creates or updates tapi.connectivity.ConnectivityServiceRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1018,7 +1088,7 @@ paths: type: "string" - in: "body" name: "tapi.connectivity.ConnectivityServiceRef.body-param" - description: "tapi.connectivity.ConnectivityServiceRef to be added to list" + description: "tapi.connectivity.ConnectivityServiceRef to be added or updated" required: false schema: $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" @@ -1027,12 +1097,13 @@ paths: description: "Object created" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + 204: + description: "Object modified" + delete: tags: - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityServiceRef" + summary: "removes tapi.connectivity.ConnectivityServiceRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1044,44 +1115,35 @@ paths: description: "Id of diversity-exclusion" required: true type: "string" - - in: "body" - name: "tapi.connectivity.ConnectivityServiceRef.body-param" - description: "tapi.connectivity.ConnectivityServiceRef to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" responses: - 201: - description: "Object created" 400: description: "Internal error" 204: - description: "Object modified" - delete: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/requested-capacity/: + get: tags: - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityServiceRef" + summary: "returns tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "connectivity-service-uuid" - in: "path" - description: "Id of diversity-exclusion" - required: true - type: "string" responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point/: post: tags: - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceEndPoint" + summary: "creates tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" @@ -1089,12 +1151,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.connectivity.ConnectivityServiceEndPoint.body-param" - description: "tapi.connectivity.ConnectivityServiceEndPoint to be added to\ - \ list" + name: "tapi.common.Capacity.body-param" + description: "tapi.common.Capacity to be added to list" required: false schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" + $ref: "#/definitions/tapi.common.Capacity" responses: 201: description: "Object created" @@ -1102,51 +1163,84 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/: - get: + put: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityServiceEndPoint" + summary: "creates or updates tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" + - in: "body" + name: "tapi.common.Capacity.body-param" + description: "tapi.common.Capacity to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.Capacity" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.common.Capacity" + description: "none" + parameters: + - name: "uuid" in: "path" - description: "Id of end-point" + description: "Id of connectivity-service" required: true type: "string" responses: - 200: - description: "tapi.connectivity.ConnectivityServiceEndPoint" - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" 400: description: "Internal error" - post: + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/requested-capacity/total-size/: + get: tags: - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceEndPoint" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" required: true type: "string" - in: "body" - name: "tapi.connectivity.ConnectivityServiceEndPoint.body-param" - description: "tapi.connectivity.ConnectivityServiceEndPoint to be added to\ - \ list" + name: "tapi.common.CapacityValue.body-param" + description: "tapi.common.CapacityValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" + $ref: "#/definitions/tapi.common.CapacityValue" responses: 201: description: "Object created" @@ -1157,25 +1251,21 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityServiceEndPoint" + summary: "creates or updates tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - in: "body" - name: "tapi.connectivity.ConnectivityServiceEndPoint.body-param" - description: "tapi.connectivity.ConnectivityServiceEndPoint to be added or\ - \ updated" + name: "tapi.common.CapacityValue.body-param" + description: "tapi.common.CapacityValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" + $ref: "#/definitions/tapi.common.CapacityValue" responses: 201: description: "Object created" @@ -1186,67 +1276,56 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityServiceEndPoint" + summary: "removes tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/: + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/schedule/: get: tags: - "tapi-connectivity" - description: "returns tapi.common.Capacity" + summary: "returns tapi.common.TimeRange" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" responses: 200: - description: "tapi.common.Capacity" + description: "tapi.common.TimeRange" schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.common.TimeRange" 400: description: "Internal error" post: tags: - "tapi-connectivity" - description: "creates tapi.common.Capacity" + summary: "creates tapi.common.TimeRange" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - in: "body" - name: "tapi.common.Capacity.body-param" - description: "tapi.common.Capacity to be added to list" + name: "tapi.common.TimeRange.body-param" + description: "tapi.common.TimeRange to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.common.TimeRange" responses: 201: description: "Object created" @@ -1257,24 +1336,20 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.Capacity" + summary: "creates or updates tapi.common.TimeRange" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - in: "body" - name: "tapi.common.Capacity.body-param" - description: "tapi.common.Capacity to be added or updated" + name: "tapi.common.TimeRange.body-param" + description: "tapi.common.TimeRange to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.common.TimeRange" responses: 201: description: "Object created" @@ -1285,50 +1360,51 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.Capacity" + summary: "removes tapi.common.TimeRange" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/: - get: + /data/context/connectivity-context/connectivity-service={uuid}/end-point/: + post: tags: - "tapi-connectivity" - description: "returns tapi.common.BandwidthProfile" + summary: "creates tapi.connectivity.ConnectivityServiceEndPoint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" + - in: "body" + name: "tapi.connectivity.ConnectivityServiceEndPoint.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPoint to be added to\ + \ list" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/: + get: tags: - "tapi-connectivity" - description: "creates tapi.common.BandwidthProfile" + summary: "returns tapi.connectivity.ConnectivityServiceEndPoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -1340,23 +1416,18 @@ paths: description: "Id of end-point" required: true type: "string" - - in: "body" - name: "tapi.common.BandwidthProfile.body-param" - description: "tapi.common.BandwidthProfile to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" responses: - 201: - description: "Object created" + 200: + description: "tapi.connectivity.ConnectivityServiceEndPoint" + schema: + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.BandwidthProfile" + summary: "creates or updates tapi.connectivity.ConnectivityServiceEndPoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -1369,11 +1440,12 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.BandwidthProfile.body-param" - description: "tapi.common.BandwidthProfile to be added or updated" + name: "tapi.connectivity.ConnectivityServiceEndPoint.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPoint to be added or\ + \ updated" required: false schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" responses: 201: description: "Object created" @@ -1384,7 +1456,8 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.BandwidthProfile" + summary: "removes tapi.connectivity.ConnectivityServiceEndPoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -1401,11 +1474,12 @@ paths: description: "Internal error" 204: description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-burst-size/ - : get: + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/: + get: tags: - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" @@ -1419,15 +1493,16 @@ paths: type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" post: tags: - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + summary: "creates tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" @@ -1440,11 +1515,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.common.Capacity.body-param" + description: "tapi.common.Capacity to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" responses: 201: description: "Object created" @@ -1455,7 +1530,8 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" @@ -1468,11 +1544,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.common.Capacity.body-param" + description: "tapi.common.Capacity to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" responses: 201: description: "Object created" @@ -1483,7 +1559,8 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" @@ -1500,11 +1577,13 @@ paths: description: "Internal error" 204: description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-information-rate/ - : get: + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/total-size/: + get: tags: - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -1526,7 +1605,9 @@ paths: post: tags: - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + summary: "creates tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -1554,7 +1635,9 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -1582,7 +1665,9 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -1599,11 +1684,12 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-burst-size/: - get: + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/connection-end-point={topology-uuid},{node-uuid},{node-edge-point-uuid},{connection-end-point-uuid}/ + : get: tags: - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.connectivity.ConnectionEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1615,17 +1701,41 @@ paths: description: "Id of end-point" required: true type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.connectivity.ConnectionEndPointRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.connectivity.ConnectionEndPointRef" 400: description: "Internal error" + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/name/: post: tags: - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -1638,11 +1748,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -1650,10 +1760,44 @@ paths: description: "Internal error" 409: description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/name={value-name}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -1665,12 +1809,17 @@ paths: description: "Id of end-point" required: true type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -1681,7 +1830,10 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -1693,16 +1845,22 @@ paths: description: "Id of end-point" required: true type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-information-rate/ - : get: + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/peer-fwd-connectivity-service-end-point/: + get: tags: - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1716,15 +1874,16 @@ paths: type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.connectivity.ConnectivityServiceEndPointRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" 400: description: "Internal error" post: tags: - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + summary: "creates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1737,11 +1896,12 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" responses: 201: description: "Object created" @@ -1752,7 +1912,8 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1765,11 +1926,12 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" responses: 201: description: "Object created" @@ -1780,7 +1942,8 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1797,11 +1960,12 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/total-size/: + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/protecting-connectivity-service-end-point/: get: tags: - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1815,15 +1979,16 @@ paths: type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.connectivity.ConnectivityServiceEndPointRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" 400: description: "Internal error" post: tags: - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + summary: "creates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1836,11 +2001,12 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" responses: 201: description: "Object created" @@ -1851,7 +2017,8 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1864,11 +2031,12 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" responses: 201: description: "Object created" @@ -1879,7 +2047,8 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1896,83 +2065,12 @@ paths: description: "Internal error" 204: description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/connection-end-point={topology-uuid},{node-uuid},{node-edge-point-uuid},{connection-end-point-uuid}/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.connectivity.ConnectionEndPointRef" - schema: - $ref: "#/definitions/tapi.connectivity.ConnectionEndPointRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/name/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/name={value-name}/: + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/server-connectivity-service-end-point/: get: tags: - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1984,22 +2082,18 @@ paths: description: "Id of end-point" required: true type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.connectivity.ConnectivityServiceEndPointRef" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" 400: description: "Internal error" post: tags: - "tapi-connectivity" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -2011,17 +2105,13 @@ paths: description: "Id of end-point" required: true type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ to list" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" responses: 201: description: "Object created" @@ -2032,7 +2122,8 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.NameAndValue" + summary: "creates or updates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -2044,17 +2135,13 @@ paths: description: "Id of end-point" required: true type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ or updated" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" responses: 201: description: "Object created" @@ -2065,7 +2152,8 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -2077,11 +2165,6 @@ paths: description: "Id of end-point" required: true type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" responses: 400: description: "Internal error" @@ -2091,7 +2174,8 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.common.ServiceInterfacePointRef" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -2113,7 +2197,8 @@ paths: post: tags: - "tapi-connectivity" - description: "creates tapi.common.ServiceInterfacePointRef" + summary: "creates tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -2141,7 +2226,8 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.ServiceInterfacePointRef" + summary: "creates or updates tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -2169,7 +2255,8 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.ServiceInterfacePointRef" + summary: "removes tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -2186,255 +2273,232 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/exclude-link={topology-uuid},{link-uuid}/: - get: + /data/context/connectivity-context/connectivity-service={uuid}/name/: + post: tags: - "tapi-connectivity" - description: "returns tapi.topology.LinkRef" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of exclude-link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of exclude-link" - required: true - type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/exclude-node={topology-uuid},{node-uuid}/: + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/name={value-name}/: get: tags: - "tapi-connectivity" - description: "returns tapi.topology.NodeRef" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of exclude-node" - required: true - type: "string" - - name: "node-uuid" + - name: "value-name" in: "path" - description: "Id of exclude-node" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.topology.NodeRef" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.topology.NodeRef" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/exclude-path={path-uuid}/: - get: + put: tags: - "tapi-connectivity" - description: "returns tapi.path.computation.PathRef" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "path-uuid" + - name: "value-name" in: "path" - description: "Id of exclude-path" + description: "Id of name" required: true type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/include-link={topology-uuid},{link-uuid}/: - get: + 204: + description: "Object modified" + delete: tags: - "tapi-connectivity" - description: "returns tapi.topology.LinkRef" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-link" - required: true - type: "string" - - name: "link-uuid" + - name: "value-name" in: "path" - description: "Id of include-link" + description: "Id of name" required: true type: "string" responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" 400: description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/include-node={topology-uuid},{node-uuid}/: + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/resilience-constraint/: get: tags: - "tapi-connectivity" - description: "returns tapi.topology.NodeRef" + summary: "returns tapi.connectivity.ResilienceConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-node" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of include-node" - required: true - type: "string" responses: 200: - description: "tapi.topology.NodeRef" + description: "tapi.connectivity.ResilienceConstraint" schema: - $ref: "#/definitions/tapi.topology.NodeRef" + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" 400: description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/include-path={path-uuid}/: - get: + post: tags: - "tapi-connectivity" - description: "returns tapi.path.computation.PathRef" + summary: "creates tapi.connectivity.ResilienceConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "path-uuid" - in: "path" - description: "Id of include-path" - required: true - type: "string" + - in: "body" + name: "tapi.connectivity.ResilienceConstraint.body-param" + description: "tapi.connectivity.ResilienceConstraint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/include-topology={topology-uuid}/: - get: + 409: + description: "Object already exists" + put: tags: - "tapi-connectivity" - description: "returns tapi.topology.TopologyRef" + summary: "creates or updates tapi.connectivity.ResilienceConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-topology" - required: true - type: "string" + - in: "body" + name: "tapi.connectivity.ResilienceConstraint.body-param" + description: "tapi.connectivity.ResilienceConstraint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/latency-characteristic/: - post: + 204: + description: "Object modified" + delete: tags: - "tapi-connectivity" - description: "creates tapi.topology.LatencyCharacteristic" + summary: "removes tapi.connectivity.ResilienceConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" responses: - 201: - description: "Object created" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/latency-characteristic={traffic-property-name}/: + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/: get: tags: - "tapi-connectivity" - description: "returns tapi.topology.LatencyCharacteristic" + summary: "returns tapi.path.computation.RoutingConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" responses: 200: - description: "tapi.topology.LatencyCharacteristic" + description: "tapi.path.computation.RoutingConstraint" schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" 400: description: "Internal error" post: tags: - "tapi-connectivity" - description: "creates tapi.topology.LatencyCharacteristic" + summary: "creates tapi.path.computation.RoutingConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" + name: "tapi.path.computation.RoutingConstraint.body-param" + description: "tapi.path.computation.RoutingConstraint to be added to list" required: false schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" responses: 201: description: "Object created" @@ -2445,24 +2509,20 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.topology.LatencyCharacteristic" + summary: "creates or updates tapi.path.computation.RoutingConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added or updated" + name: "tapi.path.computation.RoutingConstraint.body-param" + description: "tapi.path.computation.RoutingConstraint to be added or updated" required: false schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" responses: 201: description: "Object created" @@ -2473,28 +2533,26 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.topology.LatencyCharacteristic" + summary: "removes tapi.path.computation.RoutingConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/name/: + /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/cost-characteristic/: post: tags: - "tapi-connectivity" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" @@ -2502,11 +2560,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.topology.CostCharacteristic.body-param" + description: "tapi.topology.CostCharacteristic to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.topology.CostCharacteristic" responses: 201: description: "Object created" @@ -2514,78 +2572,54 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/name={value-name}/: + /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/cost-characteristic={cost-name}/: get: tags: - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "value-name" + - name: "cost-name" in: "path" - description: "Id of name" + description: "Id of cost-characteristic" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.topology.CostCharacteristic" schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" + $ref: "#/definitions/tapi.topology.CostCharacteristic" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.NameAndValue" + summary: "creates or updates tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "value-name" + - name: "cost-name" in: "path" - description: "Id of name" + description: "Id of cost-characteristic" required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" + name: "tapi.topology.CostCharacteristic.body-param" + description: "tapi.topology.CostCharacteristic to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.topology.CostCharacteristic" responses: 201: description: "Object created" @@ -2596,16 +2630,18 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "value-name" + - name: "cost-name" in: "path" - description: "Id of name" + description: "Id of cost-characteristic" required: true type: "string" responses: @@ -2613,63 +2649,80 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/: - get: + /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/latency-characteristic/: + post: tags: - "tapi-connectivity" - description: "returns tapi.common.Capacity" + summary: "creates tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - in: "body" + name: "tapi.topology.LatencyCharacteristic.body-param" + description: "tapi.topology.LatencyCharacteristic to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + ? /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/ + : get: tags: - "tapi-connectivity" - description: "creates tapi.common.Capacity" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - in: "body" - name: "tapi.common.Capacity.body-param" - description: "tapi.common.Capacity to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.Capacity" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" responses: - 201: - description: "Object created" + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.Capacity" + summary: "creates or updates tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" - in: "body" - name: "tapi.common.Capacity.body-param" - description: "tapi.common.Capacity to be added or updated" + name: "tapi.topology.LatencyCharacteristic.body-param" + description: "tapi.topology.LatencyCharacteristic to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" responses: 201: description: "Object created" @@ -2680,75 +2733,96 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.Capacity" + summary: "removes tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/: - get: + /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/risk-diversity-characteristic/: + post: tags: - "tapi-connectivity" - description: "returns tapi.common.BandwidthProfile" + summary: "creates tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - in: "body" + name: "tapi.topology.RiskCharacteristic.body-param" + description: "tapi.topology.RiskCharacteristic to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + ? /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/ + : get: tags: - "tapi-connectivity" - description: "creates tapi.common.BandwidthProfile" + summary: "returns tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - in: "body" - name: "tapi.common.BandwidthProfile.body-param" - description: "tapi.common.BandwidthProfile to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-diversity-characteristic" + required: true + type: "string" responses: - 201: - description: "Object created" + 200: + description: "tapi.topology.RiskCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.BandwidthProfile" + summary: "creates or updates tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-diversity-characteristic" + required: true + type: "string" - in: "body" - name: "tapi.common.BandwidthProfile.body-param" - description: "tapi.common.BandwidthProfile to be added or updated" + name: "tapi.topology.RiskCharacteristic.body-param" + description: "tapi.topology.RiskCharacteristic to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.topology.RiskCharacteristic" responses: 201: description: "Object created" @@ -2759,40 +2833,30 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.BandwidthProfile" + summary: "removes tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" + - name: "risk-characteristic-name" in: "path" - description: "Id of connectivity-service" + description: "Id of risk-diversity-characteristic" required: true type: "string" responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/topology-constraint/: post: tags: - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + summary: "creates tapi.path.computation.TopologyConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -2800,11 +2864,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.path.computation.TopologyConstraint.body-param" + description: "tapi.path.computation.TopologyConstraint to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" responses: 201: description: "Object created" @@ -2812,78 +2876,105 @@ paths: description: "Internal error" 409: description: "Object already exists" - put: + /data/context/connectivity-context/connectivity-service={uuid}/topology-constraint={local-id}/: + get: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + summary: "returns tapi.path.computation.TopologyConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" responses: - 201: - description: "Object created" + 200: + description: "tapi.path.computation.TopologyConstraint" + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + put: tags: - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + summary: "creates or updates tapi.path.computation.TopologyConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.TopologyConstraint.body-param" + description: "tapi.path.computation.TopologyConstraint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" responses: + 201: + description: "Object created" 400: description: "Internal error" 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/committed-information-rate/: - get: + description: "Object modified" + delete: tags: - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" + summary: "removes tapi.path.computation.TopologyConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/topology-constraint={local-id}/name/: post: tags: - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -2891,78 +2982,116 @@ paths: description: "Internal error" 409: description: "Object already exists" - put: + /data/context/connectivity-context/connectivity-service={uuid}/topology-constraint={local-id}/name={value-name}/: + get: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" responses: - 201: - description: "Object created" + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + put: tags: - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" responses: + 201: + description: "Object created" 400: description: "Internal error" 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/peak-burst-size/: - get: + description: "Object modified" + delete: tags: - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" + 204: + description: "Object deleted" + /data/context/name/: post: tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + - "tapi-common" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -2970,22 +3099,46 @@ paths: description: "Internal error" 409: description: "Object already exists" + /data/context/name={value-name}/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" put: tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + - "tapi-common" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - - name: "uuid" + - name: "value-name" in: "path" - description: "Id of connectivity-service" + description: "Id of name" required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -2995,12 +3148,15 @@ paths: description: "Object modified" delete: tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + - "tapi-common" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - - name: "uuid" + - name: "value-name" in: "path" - description: "Id of connectivity-service" + description: "Id of name" required: true type: "string" responses: @@ -3008,40 +3164,33 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/peak-information-rate/: + /data/context/notification-context/: get: tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" + - "tapi-notification" + summary: "returns tapi.notification.context.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: [] responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.notification.context.NotificationContext" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.notification.context.NotificationContext" 400: description: "Internal error" post: tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + - "tapi-notification" + summary: "creates tapi.notification.context.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.notification.context.NotificationContext.body-param" + description: "tapi.notification.context.NotificationContext to be added to\ + \ list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.notification.context.NotificationContext" responses: 201: description: "Object created" @@ -3051,20 +3200,17 @@ paths: description: "Object already exists" put: tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + - "tapi-notification" + summary: "creates or updates tapi.notification.context.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.notification.context.NotificationContext.body-param" + description: "tapi.notification.context.NotificationContext to be added or\ + \ updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.notification.context.NotificationContext" responses: 201: description: "Object created" @@ -3074,76 +3220,73 @@ paths: description: "Object modified" delete: tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" + - "tapi-notification" + summary: "removes tapi.notification.context.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: [] responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/total-size/: - get: + /data/context/notification-context/notif-subscription/: + post: tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" + - "tapi-notification" + summary: "creates tapi.notification.NotificationSubscriptionService" + description: "none" parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" + - in: "body" + name: "tapi.notification.NotificationSubscriptionService.body-param" + description: "tapi.notification.NotificationSubscriptionService to be added\ + \ to list" + required: false + schema: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + /data/context/notification-context/notif-subscription={uuid}/: + get: tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + - "tapi-notification" + summary: "returns tapi.notification.NotificationSubscriptionService" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" required: true type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.notification.NotificationSubscriptionService" + schema: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + - "tapi-notification" + summary: "creates or updates tapi.notification.NotificationSubscriptionService" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.notification.NotificationSubscriptionService.body-param" + description: "tapi.notification.NotificationSubscriptionService to be added\ + \ or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" responses: 201: description: "Object created" @@ -3153,12 +3296,13 @@ paths: description: "Object modified" delete: tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + - "tapi-notification" + summary: "removes tapi.notification.NotificationSubscriptionService" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" required: true type: "string" responses: @@ -3166,63 +3310,83 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/resilience-type/: - get: + /data/context/notification-context/notif-subscription={uuid}/name/: + post: tags: - - "tapi-connectivity" - description: "returns tapi.topology.ResilienceType" + - "tapi-notification" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" required: true type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" responses: - 200: - description: "tapi.topology.ResilienceType" - schema: - $ref: "#/definitions/tapi.topology.ResilienceType" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + /data/context/notification-context/notif-subscription={uuid}/name={value-name}/: + get: tags: - - "tapi-connectivity" - description: "creates tapi.topology.ResilienceType" + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" required: true type: "string" - - in: "body" - name: "tapi.topology.ResilienceType.body-param" - description: "tapi.topology.ResilienceType to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.ResilienceType" responses: - 201: - description: "Object created" + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - - "tapi-connectivity" - description: "creates or updates tapi.topology.ResilienceType" + - "tapi-notification" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" required: true type: "string" - in: "body" - name: "tapi.topology.ResilienceType.body-param" - description: "tapi.topology.ResilienceType to be added or updated" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.topology.ResilienceType" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -3232,12 +3396,20 @@ paths: description: "Object modified" delete: tags: - - "tapi-connectivity" - description: "removes tapi.topology.ResilienceType" + - "tapi-notification" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" required: true type: "string" responses: @@ -3245,261 +3417,229 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/risk-diversity-characteristic/: - post: + /data/context/notification-context/notif-subscription={uuid}/notification-channel/: + get: tags: - - "tapi-connectivity" - description: "creates tapi.topology.RiskCharacteristic" + - "tapi-notification" + summary: "returns tapi.notification.NotificationChannel" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" required: true type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" responses: - 201: - description: "Object created" + 200: + description: "tapi.notification.NotificationChannel" + schema: + $ref: "#/definitions/tapi.notification.NotificationChannel" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/risk-diversity-characteristic={risk-characteristic-name}/: + /data/context/notification-context/notif-subscription={uuid}/notification-channel/name={value-name}/: get: tags: - - "tapi-connectivity" - description: "returns tapi.topology.RiskCharacteristic" + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" required: true type: "string" - - name: "risk-characteristic-name" + - name: "value-name" in: "path" - description: "Id of risk-diversity-characteristic" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.topology.RiskCharacteristic" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/: + get: tags: - - "tapi-connectivity" - description: "creates tapi.topology.RiskCharacteristic" + - "tapi-notification" + summary: "returns tapi.notification.Notification" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" required: true type: "string" - - name: "risk-characteristic-name" + - name: "notification-uuid" in: "path" - description: "Id of risk-diversity-characteristic" + description: "Id of notification" required: true type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" responses: - 201: - description: "Object created" + 200: + description: "tapi.notification.Notification" + schema: + $ref: "#/definitions/tapi.notification.Notification" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/additional-info={value-name}/: + get: tags: - - "tapi-connectivity" - description: "creates or updates tapi.topology.RiskCharacteristic" + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" required: true type: "string" - - name: "risk-characteristic-name" + - name: "notification-uuid" in: "path" - description: "Id of risk-diversity-characteristic" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of additional-info" required: true type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" responses: - 201: - description: "Object created" + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/changed-attributes={value-name}/: + get: tags: - - "tapi-connectivity" - description: "removes tapi.topology.RiskCharacteristic" + - "tapi-notification" + summary: "returns tapi.notification.NameAndValueChange" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" required: true type: "string" - - name: "risk-characteristic-name" + - name: "notification-uuid" in: "path" - description: "Id of risk-diversity-characteristic" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of changed-attributes" required: true type: "string" responses: + 200: + description: "tapi.notification.NameAndValueChange" + schema: + $ref: "#/definitions/tapi.notification.NameAndValueChange" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/schedule/: + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/name={value-name}/: get: tags: - - "tapi-connectivity" - description: "returns tapi.common.TimeRange" + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.common.TimeRange" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.common.TimeRange" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/target-object-name={value-name}/: + get: tags: - - "tapi-connectivity" - description: "creates tapi.common.TimeRange" + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" required: true type: "string" - - in: "body" - name: "tapi.common.TimeRange.body-param" - description: "tapi.common.TimeRange to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.TimeRange" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.TimeRange" - parameters: - - name: "uuid" + - name: "notification-uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of target-object-name" required: true type: "string" - - in: "body" - name: "tapi.common.TimeRange.body-param" - description: "tapi.common.TimeRange to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.TimeRange" responses: - 201: - description: "Object created" + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/: + get: tags: - - "tapi-connectivity" - description: "removes tapi.common.TimeRange" + - "tapi-notification" + summary: "returns tapi.notification.SubscriptionFilter" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/name/: - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/name={value-name}/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of notif-subscription" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.notification.SubscriptionFilter" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" 400: description: "Internal error" post: tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" + - "tapi-notification" + summary: "creates tapi.notification.SubscriptionFilter" + description: "none" parameters: - - name: "value-name" + - name: "uuid" in: "path" - description: "Id of name" + description: "Id of notif-subscription" required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.notification.SubscriptionFilter.body-param" + description: "tapi.notification.SubscriptionFilter to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" responses: 201: description: "Object created" @@ -3509,20 +3649,21 @@ paths: description: "Object already exists" put: tags: - - "tapi-common" - description: "creates or updates tapi.common.NameAndValue" + - "tapi-notification" + summary: "creates or updates tapi.notification.SubscriptionFilter" + description: "none" parameters: - - name: "value-name" + - name: "uuid" in: "path" - description: "Id of name" + description: "Id of notif-subscription" required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" + name: "tapi.notification.SubscriptionFilter.body-param" + description: "tapi.notification.SubscriptionFilter to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" responses: 201: description: "Object created" @@ -3532,12 +3673,13 @@ paths: description: "Object modified" delete: tags: - - "tapi-common" - description: "removes tapi.common.NameAndValue" + - "tapi-notification" + summary: "removes tapi.notification.SubscriptionFilter" + description: "none" parameters: - - name: "value-name" + - name: "uuid" in: "path" - description: "Id of name" + description: "Id of notif-subscription" required: true type: "string" responses: @@ -3545,78 +3687,26 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/notification-context/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NotificationContext" - parameters: [] - responses: - 200: - description: "tapi.notification.NotificationContext" - schema: - $ref: "#/definitions/tapi.notification.NotificationContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationContext" - parameters: - - in: "body" - name: "tapi.notification.NotificationContext.body-param" - description: "tapi.notification.NotificationContext to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.notification.NotificationContext" - parameters: - - in: "body" - name: "tapi.notification.NotificationContext.body-param" - description: "tapi.notification.NotificationContext to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.notification.NotificationContext" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription/: + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name/: post: tags: - "tapi-notification" - description: "creates tapi.notification.NotificationSubscriptionService" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" - in: "body" - name: "tapi.notification.NotificationSubscriptionService.body-param" - description: "tapi.notification.NotificationSubscriptionService to be added\ - \ to list" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -3624,65 +3714,56 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/: + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name={value-name}/: get: tags: - "tapi-notification" - description: "returns tapi.notification.NotificationSubscriptionService" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of notif-subscription" required: true type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" responses: 200: - description: "tapi.notification.NotificationSubscriptionService" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: + put: tags: - "tapi-notification" - description: "creates tapi.notification.NotificationSubscriptionService" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of notif-subscription" required: true type: "string" - - in: "body" - name: "tapi.notification.NotificationSubscriptionService.body-param" - description: "tapi.notification.NotificationSubscriptionService to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.notification.NotificationSubscriptionService" - parameters: - - name: "uuid" + - name: "value-name" in: "path" - description: "Id of notif-subscription" + description: "Id of name" required: true type: "string" - in: "body" - name: "tapi.notification.NotificationSubscriptionService.body-param" - description: "tapi.notification.NotificationSubscriptionService to be added\ - \ or updated" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -3693,56 +3774,60 @@ paths: delete: tags: - "tapi-notification" - description: "removes tapi.notification.NotificationSubscriptionService" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of notif-subscription" required: true type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/name/: - post: + /data/context/notification-context/notification={uuid}/: + get: tags: - "tapi-notification" - description: "creates tapi.common.NameAndValue" + summary: "returns tapi.notification.notificationcontext.Notification" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of notification" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.notification.notificationcontext.Notification" + schema: + $ref: "#/definitions/tapi.notification.notificationcontext.Notification" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/name={value-name}/: + /data/context/notification-context/notification={uuid}/additional-info={value-name}/: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of notification" required: true type: "string" - name: "value-name" in: "path" - description: "Id of name" + description: "Id of additional-info" required: true type: "string" responses: @@ -3752,70 +3837,61 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: + /data/context/notification-context/notification={uuid}/alarm-info/: + get: tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" + - "tapi-oam" + summary: "returns tapi.oam.AlarmInfo" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of notification" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.oam.AlarmInfo" + schema: + $ref: "#/definitions/tapi.oam.AlarmInfo" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + /data/context/notification-context/notification={uuid}/changed-attributes={value-name}/: + get: tags: - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" + summary: "returns tapi.notification.NameAndValueChange" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of notification" required: true type: "string" - name: "value-name" in: "path" - description: "Id of name" + description: "Id of changed-attributes" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.notification.NameAndValueChange" + schema: + $ref: "#/definitions/tapi.notification.NameAndValueChange" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + /data/context/notification-context/notification={uuid}/name={value-name}/: + get: tags: - "tapi-notification" - description: "removes tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of notification" required: true type: "string" - name: "value-name" @@ -3824,157 +3900,177 @@ paths: required: true type: "string" responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/notification-channel/: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/target-object-name={value-name}/: get: tags: - "tapi-notification" - description: "returns tapi.notification.NotificationChannel" + summary: "returns tapi.common.NameAndValue" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of target-object-name" required: true type: "string" responses: 200: - description: "tapi.notification.NotificationChannel" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: + /data/context/notification-context/notification={uuid}/tca-info/: + get: tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationChannel" + - "tapi-oam" + summary: "returns tapi.oam.TcaInfo" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of notification" required: true type: "string" - - in: "body" - name: "tapi.notification.NotificationChannel.body-param" - description: "tapi.notification.NotificationChannel to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" responses: - 201: - description: "Object created" + 200: + description: "tapi.oam.TcaInfo" + schema: + $ref: "#/definitions/tapi.oam.TcaInfo" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + /data/context/notification-context/notification={uuid}/tca-info/oam-job/: + get: tags: - - "tapi-notification" - description: "creates or updates tapi.notification.NotificationChannel" + - "tapi-oam" + summary: "returns tapi.oam.OamJobRef" + description: "MEF 35.1\r\n Identification of the PM Session for\ + \ which the TCA Function was configured." parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of notification" required: true type: "string" - - in: "body" - name: "tapi.notification.NotificationChannel.body-param" - description: "tapi.notification.NotificationChannel to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" responses: - 201: - description: "Object created" + 200: + description: "tapi.oam.OamJobRef" + schema: + $ref: "#/definitions/tapi.oam.OamJobRef" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + /data/context/notification-context/notification={uuid}/tca-info/threshold-parameter/: + get: tags: - - "tapi-notification" - description: "removes tapi.notification.NotificationChannel" + - "tapi-oam" + summary: "returns tapi.oam.ThresholdParameter" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of notification" required: true type: "string" responses: + 200: + description: "tapi.oam.ThresholdParameter" + schema: + $ref: "#/definitions/tapi.oam.ThresholdParameter" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/notification-channel/name/: - post: + /data/context/notification-context/notification={uuid}/tca-info/threshold-parameter/pm-parameter-above-thrs/: + get: tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" + - "tapi-oam" + summary: "returns tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of notification" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.oam.PmParameterValue" + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/notification-channel/name={value-name}/: + /data/context/notification-context/notification={uuid}/tca-info/threshold-parameter/pm-parameter-below-thrs/: get: tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" + - "tapi-oam" + summary: "returns tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of notification" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.oam.PmParameterValue" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.oam.PmParameterValue" 400: description: "Internal error" - post: + /data/context/notification-context/notification={uuid}/tca-info/threshold-parameter/pm-parameter-clear-thrs/: + get: tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" + - "tapi-oam" + summary: "returns tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of notification" required: true type: "string" + responses: + 200: + description: "tapi.oam.PmParameterValue" + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + 400: + description: "Internal error" + /data/context/oam-context/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.OamContext" + description: "Augments the base TAPI Context with OamService information" + parameters: [] + responses: + 200: + description: "tapi.oam.OamContext" + schema: + $ref: "#/definitions/tapi.oam.OamContext" + 400: + description: "Internal error" + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.OamContext" + description: "Augments the base TAPI Context with OamService information" + parameters: - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.oam.OamContext.body-param" + description: "tapi.oam.OamContext to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.oam.OamContext" responses: 201: description: "Object created" @@ -3984,25 +4080,16 @@ paths: description: "Object already exists" put: tags: - - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" + - "tapi-oam" + summary: "creates or updates tapi.oam.OamContext" + description: "Augments the base TAPI Context with OamService information" parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" + name: "tapi.oam.OamContext.body-param" + description: "tapi.oam.OamContext to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.oam.OamContext" responses: 201: description: "Object created" @@ -4012,66 +4099,83 @@ paths: description: "Object modified" delete: tags: - - "tapi-notification" - description: "removes tapi.common.NameAndValue" + - "tapi-oam" + summary: "removes tapi.oam.OamContext" + description: "Augments the base TAPI Context with OamService information" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/meg={uuid}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.Meg" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of meg" required: true type: "string" responses: + 200: + description: "tapi.oam.Meg" + schema: + $ref: "#/definitions/tapi.oam.Meg" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/: + /data/context/oam-context/meg={uuid}/mep={local-id}/: get: tags: - - "tapi-notification" - description: "returns tapi.notification.Notification" + - "tapi-oam" + summary: "returns tapi.oam.Mep" + description: "1. ME may have 0 MEPs (case of transit domains where at least\ + \ 1 MIP is present)\r\n 2. ME may have 1 MEP (case of edge\ + \ domaind, where the peer MEP is ouside the managed domain)\r\n \ + \ 3. ME may have 2 MEPs" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of meg" required: true type: "string" - - name: "notification-uuid" + - name: "local-id" in: "path" - description: "Id of notification" + description: "Id of mep" required: true type: "string" responses: 200: - description: "tapi.notification.Notification" + description: "tapi.oam.Mep" schema: - $ref: "#/definitions/tapi.notification.Notification" + $ref: "#/definitions/tapi.oam.Mep" 400: description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/additional-info={value-name}/: + /data/context/oam-context/meg={uuid}/mep={local-id}/name={value-name}/: get: tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of meg" required: true type: "string" - - name: "notification-uuid" + - name: "local-id" in: "path" - description: "Id of notification" + description: "Id of mep" required: true type: "string" - name: "value-name" in: "path" - description: "Id of additional-info" + description: "Id of name" required: true type: "string" responses: @@ -4081,71 +4185,73 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/alarm-info/: + /data/context/oam-context/meg={uuid}/mip={local-id}/: get: tags: - - "tapi-notification" - description: "returns tapi.notification.AlarmInfo" + - "tapi-oam" + summary: "returns tapi.oam.Mip" + description: "ME may 0, 1, or more MIPs" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of meg" required: true type: "string" - - name: "notification-uuid" + - name: "local-id" in: "path" - description: "Id of notification" + description: "Id of mip" required: true type: "string" responses: 200: - description: "tapi.notification.AlarmInfo" + description: "tapi.oam.Mip" schema: - $ref: "#/definitions/tapi.notification.AlarmInfo" + $ref: "#/definitions/tapi.oam.Mip" 400: description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/changed-attributes={value-name}/: + /data/context/oam-context/meg={uuid}/mip={local-id}/name={value-name}/: get: tags: - - "tapi-notification" - description: "returns tapi.notification.NameAndValueChange" + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of meg" required: true type: "string" - - name: "notification-uuid" + - name: "local-id" in: "path" - description: "Id of notification" + description: "Id of mip" required: true type: "string" - name: "value-name" in: "path" - description: "Id of changed-attributes" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.notification.NameAndValueChange" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.notification.NameAndValueChange" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/name={value-name}/: + /data/context/oam-context/meg={uuid}/name={value-name}/: get: tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" + description: "Id of meg" required: true type: "string" - name: "value-name" @@ -4160,114 +4266,62 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/target-object-name={value-name}/: - get: + /data/context/oam-context/oam-job/: + post: tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" + - "tapi-oam" + summary: "creates tapi.oam.OamJob" + description: "none" parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of target-object-name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/tca-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.TcaInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" + - in: "body" + name: "tapi.oam.OamJob.body-param" + description: "tapi.oam.OamJob to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamJob" responses: - 200: - description: "tapi.notification.TcaInfo" - schema: - $ref: "#/definitions/tapi.notification.TcaInfo" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/subscription-filter/: + 409: + description: "Object already exists" + /data/context/oam-context/oam-job={uuid}/: get: tags: - - "tapi-notification" - description: "returns tapi.notification.SubscriptionFilter" + - "tapi-oam" + summary: "returns tapi.oam.OamJob" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of oam-job" required: true type: "string" responses: 200: - description: "tapi.notification.SubscriptionFilter" + description: "tapi.oam.OamJob" schema: - $ref: "#/definitions/tapi.notification.SubscriptionFilter" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.SubscriptionFilter" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.SubscriptionFilter.body-param" - description: "tapi.notification.SubscriptionFilter to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.SubscriptionFilter" - responses: - 201: - description: "Object created" + $ref: "#/definitions/tapi.oam.OamJob" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - - "tapi-notification" - description: "creates or updates tapi.notification.SubscriptionFilter" + - "tapi-oam" + summary: "creates or updates tapi.oam.OamJob" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of oam-job" required: true type: "string" - in: "body" - name: "tapi.notification.SubscriptionFilter.body-param" - description: "tapi.notification.SubscriptionFilter to be added or updated" + name: "tapi.oam.OamJob.body-param" + description: "tapi.oam.OamJob to be added or updated" required: false schema: - $ref: "#/definitions/tapi.notification.SubscriptionFilter" + $ref: "#/definitions/tapi.oam.OamJob" responses: 201: description: "Object created" @@ -4277,12 +4331,13 @@ paths: description: "Object modified" delete: tags: - - "tapi-notification" - description: "removes tapi.notification.SubscriptionFilter" + - "tapi-oam" + summary: "removes tapi.oam.OamJob" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of oam-job" required: true type: "string" responses: @@ -4290,161 +4345,146 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name/: - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name={value-name}/: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/: get: tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" + - "tapi-oam" + summary: "returns tapi.oam.CurrentData" + description: "Granularity period of the CurrentData identifies the specific\ + \ CurrentData instance in the scope of this OamJob.\r\n For\ + \ example, typically at least\r\n one 15min and\r\n \ + \ one 24hr;\r\n optionally one additional configurable\ + \ (< 15min)" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of oam-job" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of name" + description: "Id of current-data" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.oam.CurrentData" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.oam.CurrentData" 400: description: "Internal error" - post: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/elapsed-time/: + get: tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" + - "tapi-oam" + summary: "returns tapi.common.TimeInterval" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of oam-job" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of name" + description: "Id of current-data" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.common.TimeInterval" + schema: + $ref: "#/definitions/tapi.common.TimeInterval" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/elapsed-time/period={unit}/: + get: tags: - - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" + - "tapi-oam" + summary: "returns tapi.common.TimePeriod" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of oam-job" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of name" + description: "Id of current-data" + required: true + type: "string" + - name: "unit" + in: "path" + description: "Id of period" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.common.TimePeriod" + schema: + $ref: "#/definitions/tapi.common.TimePeriod" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/: + get: tags: - - "tapi-notification" - description: "removes tapi.common.NameAndValue" + - "tapi-oam" + summary: "returns tapi.oam.HistoryData" + description: "in case of 24hr Current Data, at least 1 History Data.\r\n \ + \ In case of 15min Current Data, at least 16 History Data.\r\n\ + \ In case of <15min, the number of History Data shall be able\ + \ to cover a span of 4 hours." parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of oam-job" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of name" + description: "Id of current-data" required: true type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notification={uuid}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.Notification" - parameters: - - name: "uuid" + - name: "history-data-local-id" in: "path" - description: "Id of notification" + description: "Id of history-data" required: true type: "string" responses: 200: - description: "tapi.notification.Notification" + description: "tapi.oam.HistoryData" schema: - $ref: "#/definitions/tapi.notification.Notification" + $ref: "#/definitions/tapi.oam.HistoryData" 400: description: "Internal error" - /data/context/notification-context/notification={uuid}/additional-info={value-name}/: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/name={value-name}/: get: tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of notification" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" required: true type: "string" - name: "value-name" in: "path" - description: "Id of additional-info" + description: "Id of name" required: true type: "string" responses: @@ -4454,84 +4494,86 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/notification-context/notification={uuid}/alarm-info/: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/pm-data-pac/: get: tags: - - "tapi-notification" - description: "returns tapi.notification.AlarmInfo" + - "tapi-oam" + summary: "returns tapi.oam.PmDataPac" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notification" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" required: true type: "string" responses: 200: - description: "tapi.notification.AlarmInfo" + description: "tapi.oam.PmDataPac" schema: - $ref: "#/definitions/tapi.notification.AlarmInfo" + $ref: "#/definitions/tapi.oam.PmDataPac" 400: description: "Internal error" - /data/context/notification-context/notification={uuid}/changed-attributes={value-name}/: - get: + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/pm-data-pac/granularity-period/ + : get: tags: - - "tapi-notification" - description: "returns tapi.notification.NameAndValueChange" + - "tapi-oam" + summary: "returns tapi.common.TimePeriod" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notification" + description: "Id of oam-job" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of changed-attributes" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" required: true type: "string" responses: 200: - description: "tapi.notification.NameAndValueChange" + description: "tapi.common.TimePeriod" schema: - $ref: "#/definitions/tapi.notification.NameAndValueChange" + $ref: "#/definitions/tapi.common.TimePeriod" 400: description: "Internal error" - /data/context/notification-context/notification={uuid}/name={value-name}/: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/name={value-name}/: get: tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of notification" + description: "Id of oam-job" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/target-object-name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" + description: "Id of current-data" required: true type: "string" - name: "value-name" in: "path" - description: "Id of target-object-name" + description: "Id of name" required: true type: "string" responses: @@ -4541,189 +4583,118 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/notification-context/notification={uuid}/tca-info/: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/pm-data-pac/: get: tags: - - "tapi-notification" - description: "returns tapi.notification.TcaInfo" + - "tapi-oam" + summary: "returns tapi.oam.PmDataPac" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notification" + description: "Id of oam-job" required: true type: "string" - responses: - 200: - description: "tapi.notification.TcaInfo" - schema: - $ref: "#/definitions/tapi.notification.TcaInfo" - 400: - description: "Internal error" - /data/context/oam-context/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.OamContext" - parameters: [] - responses: - 200: - description: "tapi.oam.OamContext" - schema: - $ref: "#/definitions/tapi.oam.OamContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamContext" - parameters: - - in: "body" - name: "tapi.oam.OamContext.body-param" - description: "tapi.oam.OamContext to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamContext" - parameters: - - in: "body" - name: "tapi.oam.OamContext.body-param" - description: "tapi.oam.OamContext to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.OamContext" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/meg={uuid}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.Meg" - parameters: - - name: "uuid" + - name: "local-id" in: "path" - description: "Id of meg" + description: "Id of current-data" required: true type: "string" responses: 200: - description: "tapi.oam.Meg" + description: "tapi.oam.PmDataPac" schema: - $ref: "#/definitions/tapi.oam.Meg" + $ref: "#/definitions/tapi.oam.PmDataPac" 400: description: "Internal error" - /data/context/oam-context/meg={uuid}/mep={local-id}/: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/pm-data-pac/granularity-period/: get: tags: - "tapi-oam" - description: "returns tapi.oam.Mep" + summary: "returns tapi.common.TimePeriod" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of meg" + description: "Id of oam-job" required: true type: "string" - name: "local-id" in: "path" - description: "Id of mep" + description: "Id of current-data" required: true type: "string" responses: 200: - description: "tapi.oam.Mep" + description: "tapi.common.TimePeriod" schema: - $ref: "#/definitions/tapi.oam.Mep" + $ref: "#/definitions/tapi.common.TimePeriod" 400: description: "Internal error" - /data/context/oam-context/meg={uuid}/mep={local-id}/name={value-name}/: - get: + /data/context/oam-context/oam-job={uuid}/name/: + post: tags: - "tapi-oam" - description: "returns tapi.common.NameAndValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mep" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of oam-job" required: true type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/oam-context/meg={uuid}/mip={local-id}/: + 409: + description: "Object already exists" + /data/context/oam-context/oam-job={uuid}/name={value-name}/: get: tags: - "tapi-oam" - description: "returns tapi.oam.Mip" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of meg" + description: "Id of oam-job" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of mip" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.oam.Mip" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.oam.Mip" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/oam-context/meg={uuid}/mip={local-id}/name={value-name}/: - get: + put: tags: - "tapi-oam" - description: "returns tapi.common.NameAndValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mip" + description: "Id of oam-job" required: true type: "string" - name: "value-name" @@ -4731,22 +4702,30 @@ paths: description: "Id of name" required: true type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/oam-context/meg={uuid}/name={value-name}/: - get: + 204: + description: "Object modified" + delete: tags: - "tapi-oam" - description: "returns tapi.common.NameAndValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of meg" + description: "Id of oam-job" required: true type: "string" - name: "value-name" @@ -4755,36 +4734,16 @@ paths: required: true type: "string" responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/oam-context/oam-job/: - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamJob" - parameters: - - in: "body" - name: "tapi.oam.OamJob.body-param" - description: "tapi.oam.OamJob to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamJob" - responses: - 201: - description: "Object created" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-job={uuid}/: + 204: + description: "Object deleted" + /data/context/oam-context/oam-job={uuid}/oam-profile/: get: tags: - "tapi-oam" - description: "returns tapi.oam.OamJob" + summary: "returns tapi.oam.OamProfileRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -4793,15 +4752,16 @@ paths: type: "string" responses: 200: - description: "tapi.oam.OamJob" + description: "tapi.oam.OamProfileRef" schema: - $ref: "#/definitions/tapi.oam.OamJob" + $ref: "#/definitions/tapi.oam.OamProfileRef" 400: description: "Internal error" post: tags: - "tapi-oam" - description: "creates tapi.oam.OamJob" + summary: "creates tapi.oam.OamProfileRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -4809,11 +4769,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.oam.OamJob.body-param" - description: "tapi.oam.OamJob to be added to list" + name: "tapi.oam.OamProfileRef.body-param" + description: "tapi.oam.OamProfileRef to be added to list" required: false schema: - $ref: "#/definitions/tapi.oam.OamJob" + $ref: "#/definitions/tapi.oam.OamProfileRef" responses: 201: description: "Object created" @@ -4824,7 +4784,8 @@ paths: put: tags: - "tapi-oam" - description: "creates or updates tapi.oam.OamJob" + summary: "creates or updates tapi.oam.OamProfileRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -4832,11 +4793,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.oam.OamJob.body-param" - description: "tapi.oam.OamJob to be added or updated" + name: "tapi.oam.OamProfileRef.body-param" + description: "tapi.oam.OamProfileRef to be added or updated" required: false schema: - $ref: "#/definitions/tapi.oam.OamJob" + $ref: "#/definitions/tapi.oam.OamProfileRef" responses: 201: description: "Object created" @@ -4847,7 +4808,8 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.oam.OamJob" + summary: "removes tapi.oam.OamProfileRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -4859,11 +4821,12 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/name/: + /data/context/oam-context/oam-job={uuid}/oam-service-point/: post: tags: - "tapi-oam" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.oam.OamServicePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -4871,11 +4834,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.oam.OamServicePointRef.body-param" + description: "tapi.oam.OamServicePointRef to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.oam.OamServicePointRef" responses: 201: description: "Object created" @@ -4883,98 +4846,88 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/oam-context/oam-job={uuid}/name={value-name}/: + /data/context/oam-context/oam-job={uuid}/oam-service-point={oam-service-uuid},{oam-service-point-local-id}/: get: tags: - "tapi-oam" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.oam.OamServicePointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - name: "value-name" + - name: "oam-service-uuid" in: "path" - description: "Id of name" + description: "Id of oam-service-point" + required: true + type: "string" + - name: "oam-service-point-local-id" + in: "path" + description: "Id of oam-service-point" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.oam.OamServicePointRef" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.oam.OamServicePointRef" 400: description: "Internal error" - post: + put: tags: - "tapi-oam" - description: "creates tapi.common.NameAndValue" + summary: "creates or updates tapi.oam.OamServicePointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - name: "value-name" + - name: "oam-service-uuid" in: "path" - description: "Id of name" + description: "Id of oam-service-point" + required: true + type: "string" + - name: "oam-service-point-local-id" + in: "path" + description: "Id of oam-service-point" required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.oam.OamServicePointRef.body-param" + description: "tapi.oam.OamServicePointRef to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.oam.OamServicePointRef" responses: 201: description: "Object created" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + 204: + description: "Object modified" + delete: tags: - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" + summary: "removes tapi.oam.OamServicePointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" + - name: "oam-service-uuid" in: "path" - description: "Id of oam-job" + description: "Id of oam-service-point" required: true type: "string" - - name: "value-name" + - name: "oam-service-point-local-id" in: "path" - description: "Id of name" + description: "Id of oam-service-point" required: true type: "string" responses: @@ -4982,11 +4935,12 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/oam-profile/: + /data/context/oam-context/oam-job={uuid}/schedule/: get: tags: - "tapi-oam" - description: "returns tapi.oam.OamProfileRef" + summary: "returns tapi.common.TimeRange" + description: "none" parameters: - name: "uuid" in: "path" @@ -4995,15 +4949,16 @@ paths: type: "string" responses: 200: - description: "tapi.oam.OamProfileRef" + description: "tapi.common.TimeRange" schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" + $ref: "#/definitions/tapi.common.TimeRange" 400: description: "Internal error" post: tags: - "tapi-oam" - description: "creates tapi.oam.OamProfileRef" + summary: "creates tapi.common.TimeRange" + description: "none" parameters: - name: "uuid" in: "path" @@ -5011,11 +4966,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.oam.OamProfileRef.body-param" - description: "tapi.oam.OamProfileRef to be added to list" + name: "tapi.common.TimeRange.body-param" + description: "tapi.common.TimeRange to be added to list" required: false schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" + $ref: "#/definitions/tapi.common.TimeRange" responses: 201: description: "Object created" @@ -5026,7 +4981,8 @@ paths: put: tags: - "tapi-oam" - description: "creates or updates tapi.oam.OamProfileRef" + summary: "creates or updates tapi.common.TimeRange" + description: "none" parameters: - name: "uuid" in: "path" @@ -5034,11 +4990,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.oam.OamProfileRef.body-param" - description: "tapi.oam.OamProfileRef to be added or updated" + name: "tapi.common.TimeRange.body-param" + description: "tapi.common.TimeRange to be added or updated" required: false schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" + $ref: "#/definitions/tapi.common.TimeRange" responses: 201: description: "Object created" @@ -5049,7 +5005,8 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.oam.OamProfileRef" + summary: "removes tapi.common.TimeRange" + description: "none" parameters: - name: "uuid" in: "path" @@ -5061,23 +5018,19 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/oam-service-end-point/: + /data/context/oam-context/oam-profile/: post: tags: - "tapi-oam" - description: "creates tapi.oam.OamServiceEndPointRef" + summary: "creates tapi.oam.OamProfile" + description: "none" parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - in: "body" - name: "tapi.oam.OamServiceEndPointRef.body-param" - description: "tapi.oam.OamServiceEndPointRef to be added to list" + name: "tapi.oam.OamProfile.body-param" + description: "tapi.oam.OamProfile to be added to list" required: false schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPointRef" + $ref: "#/definitions/tapi.oam.OamProfile" responses: 201: description: "Object created" @@ -5085,60 +5038,85 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/oam-context/oam-job={uuid}/oam-service-end-point={oam-service-uuid},{oam-service-end-point-local-id}/: + /data/context/oam-context/oam-profile={uuid}/: get: tags: - "tapi-oam" - description: "returns tapi.oam.OamServiceEndPointRef" + summary: "returns tapi.oam.OamProfile" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "oam-service-uuid" - in: "path" - description: "Id of oam-service-end-point" - required: true - type: "string" - - name: "oam-service-end-point-local-id" - in: "path" - description: "Id of oam-service-end-point" + description: "Id of oam-profile" required: true type: "string" responses: 200: - description: "tapi.oam.OamServiceEndPointRef" + description: "tapi.oam.OamProfile" schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPointRef" + $ref: "#/definitions/tapi.oam.OamProfile" 400: description: "Internal error" - post: + put: tags: - "tapi-oam" - description: "creates tapi.oam.OamServiceEndPointRef" + summary: "creates or updates tapi.oam.OamProfile" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of oam-profile" required: true type: "string" - - name: "oam-service-uuid" + - in: "body" + name: "tapi.oam.OamProfile.body-param" + description: "tapi.oam.OamProfile to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamProfile" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.OamProfile" + description: "none" + parameters: + - name: "uuid" in: "path" - description: "Id of oam-service-end-point" + description: "Id of oam-profile" required: true type: "string" - - name: "oam-service-end-point-local-id" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-profile={uuid}/name/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" in: "path" - description: "Id of oam-service-end-point" + description: "Id of oam-profile" required: true type: "string" - in: "body" - name: "tapi.oam.OamServiceEndPointRef.body-param" - description: "tapi.oam.OamServiceEndPointRef to be added to list" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPointRef" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -5146,32 +5124,56 @@ paths: description: "Internal error" 409: description: "Object already exists" - put: + /data/context/oam-context/oam-profile={uuid}/name={value-name}/: + get: tags: - "tapi-oam" - description: "creates or updates tapi.oam.OamServiceEndPointRef" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of oam-profile" required: true type: "string" - - name: "oam-service-uuid" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" in: "path" - description: "Id of oam-service-end-point" + description: "Id of oam-profile" required: true type: "string" - - name: "oam-service-end-point-local-id" + - name: "value-name" in: "path" - description: "Id of oam-service-end-point" + description: "Id of name" required: true type: "string" - in: "body" - name: "tapi.oam.OamServiceEndPointRef.body-param" - description: "tapi.oam.OamServiceEndPointRef to be added or updated" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPointRef" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -5182,21 +5184,19 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.oam.OamServiceEndPointRef" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "oam-service-uuid" - in: "path" - description: "Id of oam-service-end-point" + description: "Id of oam-profile" required: true type: "string" - - name: "oam-service-end-point-local-id" + - name: "value-name" in: "path" - description: "Id of oam-service-end-point" + description: "Id of name" required: true type: "string" responses: @@ -5204,277 +5204,300 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/: - get: + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data/: + post: tags: - "tapi-oam" - description: "returns tapi.oam.PmCurrentData" + summary: "creates tapi.oam.PmThresholdData" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" + description: "Id of oam-profile" required: true type: "string" + - in: "body" + name: "tapi.oam.PmThresholdData.body-param" + description: "tapi.oam.PmThresholdData to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.PmThresholdData" responses: - 200: - description: "tapi.oam.PmCurrentData" - schema: - $ref: "#/definitions/tapi.oam.PmCurrentData" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/elapsed-time/: + 409: + description: "Object already exists" + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/: get: tags: - "tapi-oam" - description: "returns tapi.common.TimeInterval" + summary: "returns tapi.oam.PmThresholdData" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of oam-profile" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" + description: "Id of pm-threshold-data" required: true type: "string" responses: 200: - description: "tapi.common.TimeInterval" + description: "tapi.oam.PmThresholdData" schema: - $ref: "#/definitions/tapi.common.TimeInterval" + $ref: "#/definitions/tapi.oam.PmThresholdData" 400: description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/elapsed-time/period={unit}/: - get: + put: tags: - "tapi-oam" - description: "returns tapi.common.TimePeriod" + summary: "creates or updates tapi.oam.PmThresholdData" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of oam-profile" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "unit" - in: "path" - description: "Id of period" + description: "Id of pm-threshold-data" required: true type: "string" + - in: "body" + name: "tapi.oam.PmThresholdData.body-param" + description: "tapi.oam.PmThresholdData to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.PmThresholdData" responses: - 200: - description: "tapi.common.TimePeriod" - schema: - $ref: "#/definitions/tapi.common.TimePeriod" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/granularity-period/: - get: + 204: + description: "Object modified" + delete: tags: - "tapi-oam" - description: "returns tapi.common.TimePeriod" + summary: "removes tapi.oam.PmThresholdData" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of oam-profile" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" + description: "Id of pm-threshold-data" required: true type: "string" responses: - 200: - description: "tapi.common.TimePeriod" - schema: - $ref: "#/definitions/tapi.common.TimePeriod" 400: description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/name={value-name}/: + 204: + description: "Object deleted" + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/granularity-period/: get: tags: - "tapi-oam" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.TimePeriod" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of oam-profile" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of pm-threshold-data" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.common.TimePeriod" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.common.TimePeriod" 400: description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/: - get: + post: tags: - "tapi-oam" - description: "returns tapi.oam.PmHistoryData" + summary: "creates tapi.common.TimePeriod" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of oam-profile" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" - in: "path" - description: "Id of pm-history-data" + description: "Id of pm-threshold-data" required: true type: "string" + - in: "body" + name: "tapi.common.TimePeriod.body-param" + description: "tapi.common.TimePeriod to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.TimePeriod" responses: - 200: - description: "tapi.oam.PmHistoryData" - schema: - $ref: "#/definitions/tapi.oam.PmHistoryData" + 201: + description: "Object created" 400: description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/granularity-period/ - : get: + 409: + description: "Object already exists" + put: tags: - "tapi-oam" - description: "returns tapi.common.TimePeriod" + summary: "creates or updates tapi.common.TimePeriod" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of oam-profile" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" - in: "path" - description: "Id of pm-history-data" + description: "Id of pm-threshold-data" required: true type: "string" + - in: "body" + name: "tapi.common.TimePeriod.body-param" + description: "tapi.common.TimePeriod to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.TimePeriod" responses: - 200: - description: "tapi.common.TimePeriod" - schema: - $ref: "#/definitions/tapi.common.TimePeriod" + 201: + description: "Object created" 400: description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/name={value-name}/ - : get: + 204: + description: "Object modified" + delete: tags: - "tapi-oam" - description: "returns tapi.common.NameAndValue" + summary: "removes tapi.common.TimePeriod" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of oam-profile" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" + description: "Id of pm-threshold-data" required: true type: "string" - - name: "pm-history-data-local-id" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/name/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" in: "path" - description: "Id of pm-history-data" + description: "Id of oam-profile" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of name" + description: "Id of pm-threshold-data" required: true type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/oam-context/oam-job={uuid}/schedule/: + 409: + description: "Object already exists" + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/name={value-name}/: get: tags: - "tapi-oam" - description: "returns tapi.common.TimeRange" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.common.TimeRange" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.common.TimeRange" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: + put: tags: - "tapi-oam" - description: "creates tapi.common.TimeRange" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of oam-profile" required: true type: "string" - - in: "body" - name: "tapi.common.TimeRange.body-param" - description: "tapi.common.TimeRange to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.TimeRange" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.TimeRange" - parameters: - - name: "uuid" + - name: "local-id" in: "path" - description: "Id of oam-job" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" required: true type: "string" - in: "body" - name: "tapi.common.TimeRange.body-param" - description: "tapi.common.TimeRange to be added or updated" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.TimeRange" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -5485,11 +5508,24 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.common.TimeRange" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" required: true type: "string" responses: @@ -5497,18 +5533,29 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-profile/: + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/threshold-parameter/: post: tags: - "tapi-oam" - description: "creates tapi.oam.OamProfile" + summary: "creates tapi.oam.ThresholdParameter" + description: "none" parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" - in: "body" - name: "tapi.oam.OamProfile.body-param" - description: "tapi.oam.OamProfile to be added to list" + name: "tapi.oam.ThresholdParameter.body-param" + description: "tapi.oam.ThresholdParameter to be added to list" required: false schema: - $ref: "#/definitions/tapi.oam.OamProfile" + $ref: "#/definitions/tapi.oam.ThresholdParameter" responses: 201: description: "Object created" @@ -5516,63 +5563,72 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/: - get: + ? /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/threshold-parameter={pm-parameter-name},{threshold-location}/ + : get: tags: - "tapi-oam" - description: "returns tapi.oam.OamProfile" + summary: "returns tapi.oam.ThresholdParameter" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-profile" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" responses: 200: - description: "tapi.oam.OamProfile" + description: "tapi.oam.ThresholdParameter" schema: - $ref: "#/definitions/tapi.oam.OamProfile" + $ref: "#/definitions/tapi.oam.ThresholdParameter" 400: description: "Internal error" - post: + put: tags: - "tapi-oam" - description: "creates tapi.oam.OamProfile" + summary: "creates or updates tapi.oam.ThresholdParameter" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-profile" required: true type: "string" - - in: "body" - name: "tapi.oam.OamProfile.body-param" - description: "tapi.oam.OamProfile to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamProfile" - parameters: - - name: "uuid" + - name: "local-id" in: "path" - description: "Id of oam-profile" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" required: true type: "string" - in: "body" - name: "tapi.oam.OamProfile.body-param" - description: "tapi.oam.OamProfile to be added or updated" + name: "tapi.oam.ThresholdParameter.body-param" + description: "tapi.oam.ThresholdParameter to be added or updated" required: false schema: - $ref: "#/definitions/tapi.oam.OamProfile" + $ref: "#/definitions/tapi.oam.ThresholdParameter" responses: 201: description: "Object created" @@ -5583,86 +5639,100 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.oam.OamProfile" + summary: "removes tapi.oam.ThresholdParameter" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-profile" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/name/: - post: + ? /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/threshold-parameter={pm-parameter-name},{threshold-location}/pm-parameter-above-thrs/ + : get: tags: - "tapi-oam" - description: "creates tapi.common.NameAndValue" + summary: "returns tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-profile" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" + - name: "local-id" in: "path" - description: "Id of oam-profile" + description: "Id of pm-threshold-data" required: true type: "string" - - name: "value-name" + - name: "pm-parameter-name" in: "path" - description: "Id of name" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.oam.PmParameterValue" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.oam.PmParameterValue" 400: description: "Internal error" post: tags: - "tapi-oam" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-profile" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of name" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.oam.PmParameterValue" responses: 201: description: "Object created" @@ -5673,24 +5743,35 @@ paths: put: tags: - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" + summary: "creates or updates tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-profile" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of name" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.oam.PmParameterValue" responses: 201: description: "Object created" @@ -5701,16 +5782,27 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-profile" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of name" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" required: true type: "string" responses: @@ -5718,57 +5810,45 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-bin-data/: - post: + ? /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/threshold-parameter={pm-parameter-name},{threshold-location}/pm-parameter-below-thrs/ + : get: tags: - "tapi-oam" - description: "creates tapi.oam.PmBinData" + summary: "returns tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-profile" required: true type: "string" - - in: "body" - name: "tapi.oam.PmBinData.body-param" - description: "tapi.oam.PmBinData to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.PmBinData" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/pm-bin-data={local-id}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.PmBinData" - parameters: - - name: "uuid" + - name: "local-id" in: "path" - description: "Id of oam-profile" + description: "Id of pm-threshold-data" required: true type: "string" - - name: "local-id" + - name: "pm-parameter-name" in: "path" - description: "Id of pm-bin-data" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" required: true type: "string" responses: 200: - description: "tapi.oam.PmBinData" + description: "tapi.oam.PmParameterValue" schema: - $ref: "#/definitions/tapi.oam.PmBinData" + $ref: "#/definitions/tapi.oam.PmParameterValue" 400: description: "Internal error" post: tags: - "tapi-oam" - description: "creates tapi.oam.PmBinData" + summary: "creates tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -5777,15 +5857,25 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-bin-data" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" required: true type: "string" - in: "body" - name: "tapi.oam.PmBinData.body-param" - description: "tapi.oam.PmBinData to be added to list" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.oam.PmBinData" + $ref: "#/definitions/tapi.oam.PmParameterValue" responses: 201: description: "Object created" @@ -5796,7 +5886,8 @@ paths: put: tags: - "tapi-oam" - description: "creates or updates tapi.oam.PmBinData" + summary: "creates or updates tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -5805,15 +5896,25 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-bin-data" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" required: true type: "string" - in: "body" - name: "tapi.oam.PmBinData.body-param" - description: "tapi.oam.PmBinData to be added or updated" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.oam.PmBinData" + $ref: "#/definitions/tapi.oam.PmParameterValue" responses: 201: description: "Object created" @@ -5824,7 +5925,8 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.oam.PmBinData" + summary: "removes tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -5833,7 +5935,17 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-bin-data" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" required: true type: "string" responses: @@ -5841,11 +5953,12 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-bin-data={local-id}/granularity-period/: - get: + ? /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/threshold-parameter={pm-parameter-name},{threshold-location}/pm-parameter-clear-thrs/ + : get: tags: - "tapi-oam" - description: "returns tapi.common.TimePeriod" + summary: "returns tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -5854,20 +5967,31 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-bin-data" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" required: true type: "string" responses: 200: - description: "tapi.common.TimePeriod" + description: "tapi.oam.PmParameterValue" schema: - $ref: "#/definitions/tapi.common.TimePeriod" + $ref: "#/definitions/tapi.oam.PmParameterValue" 400: description: "Internal error" post: tags: - "tapi-oam" - description: "creates tapi.common.TimePeriod" + summary: "creates tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -5876,15 +6000,25 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-bin-data" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" required: true type: "string" - in: "body" - name: "tapi.common.TimePeriod.body-param" - description: "tapi.common.TimePeriod to be added to list" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.TimePeriod" + $ref: "#/definitions/tapi.oam.PmParameterValue" responses: 201: description: "Object created" @@ -5895,7 +6029,8 @@ paths: put: tags: - "tapi-oam" - description: "creates or updates tapi.common.TimePeriod" + summary: "creates or updates tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -5904,15 +6039,25 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-bin-data" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" required: true type: "string" - in: "body" - name: "tapi.common.TimePeriod.body-param" - description: "tapi.common.TimePeriod to be added or updated" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.TimePeriod" + $ref: "#/definitions/tapi.oam.PmParameterValue" responses: 201: description: "Object created" @@ -5923,7 +6068,8 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.common.TimePeriod" + summary: "removes tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -5932,7 +6078,17 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-bin-data" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" required: true type: "string" responses: @@ -5940,81 +6096,116 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-bin-data={local-id}/name/: + /data/context/oam-context/oam-service/: post: tags: - "tapi-oam" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.oam.OamService" + description: "none" + parameters: + - in: "body" + name: "tapi.oam.OamService.body-param" + description: "tapi.oam.OamService to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-service={uuid}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.OamService" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-service" required: true type: "string" - - name: "local-id" + responses: + 200: + description: "tapi.oam.OamService" + schema: + $ref: "#/definitions/tapi.oam.OamService" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.OamService" + description: "none" + parameters: + - name: "uuid" in: "path" - description: "Id of pm-bin-data" + description: "Id of oam-service" required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.oam.OamService.body-param" + description: "tapi.oam.OamService to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.oam.OamService" responses: 201: description: "Object created" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/pm-bin-data={local-id}/name={value-name}/: - get: + 204: + description: "Object modified" + delete: tags: - "tapi-oam" - description: "returns tapi.common.NameAndValue" + summary: "removes tapi.oam.OamService" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" + description: "Id of oam-service" required: true type: "string" - - name: "value-name" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-service={uuid}/meg/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.MegRef" + description: "none" + parameters: + - name: "uuid" in: "path" - description: "Id of name" + description: "Id of oam-service" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.oam.MegRef" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.oam.MegRef" 400: description: "Internal error" + /data/context/oam-context/oam-service={uuid}/name/: post: tags: - "tapi-oam" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of oam-service" required: true type: "string" - in: "body" @@ -6030,19 +6221,43 @@ paths: description: "Internal error" 409: description: "Object already exists" - put: + /data/context/oam-context/oam-service={uuid}/name={value-name}/: + get: tags: - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-service" required: true type: "string" - - name: "local-id" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" in: "path" - description: "Id of pm-bin-data" + description: "Id of oam-service" required: true type: "string" - name: "value-name" @@ -6066,16 +6281,14 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" + description: "Id of oam-service" required: true type: "string" - name: "value-name" @@ -6088,23 +6301,24 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data/: + /data/context/oam-context/oam-service={uuid}/oam-service-point/: post: tags: - "tapi-oam" - description: "creates tapi.oam.PmThresholdData" + summary: "creates tapi.oam.OamServicePoint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-service" required: true type: "string" - in: "body" - name: "tapi.oam.PmThresholdData.body-param" - description: "tapi.oam.PmThresholdData to be added to list" + name: "tapi.oam.OamServicePoint.body-param" + description: "tapi.oam.OamServicePoint to be added to list" required: false schema: - $ref: "#/definitions/tapi.oam.PmThresholdData" + $ref: "#/definitions/tapi.oam.OamServicePoint" responses: 201: description: "Object created" @@ -6112,98 +6326,73 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/: + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/: get: tags: - "tapi-oam" - description: "returns tapi.oam.PmThresholdData" + summary: "returns tapi.oam.OamServicePoint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-service-point" required: true type: "string" responses: 200: - description: "tapi.oam.PmThresholdData" + description: "tapi.oam.OamServicePoint" schema: - $ref: "#/definitions/tapi.oam.PmThresholdData" + $ref: "#/definitions/tapi.oam.OamServicePoint" 400: description: "Internal error" - post: + put: tags: - "tapi-oam" - description: "creates tapi.oam.PmThresholdData" + summary: "creates or updates tapi.oam.OamServicePoint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-service-point" required: true type: "string" - in: "body" - name: "tapi.oam.PmThresholdData.body-param" - description: "tapi.oam.PmThresholdData to be added to list" + name: "tapi.oam.OamServicePoint.body-param" + description: "tapi.oam.OamServicePoint to be added or updated" required: false schema: - $ref: "#/definitions/tapi.oam.PmThresholdData" + $ref: "#/definitions/tapi.oam.OamServicePoint" responses: 201: description: "Object created" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + 204: + description: "Object modified" + delete: tags: - "tapi-oam" - description: "creates or updates tapi.oam.PmThresholdData" + summary: "removes tapi.oam.OamServicePoint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.oam.PmThresholdData.body-param" - description: "tapi.oam.PmThresholdData to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.PmThresholdData" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.PmThresholdData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-service-point" required: true type: "string" responses: @@ -6211,50 +6400,53 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/granularity-period/: + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/connectivity-service-end-point/: get: tags: - "tapi-oam" - description: "returns tapi.common.TimePeriod" + summary: "returns tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-service-point" required: true type: "string" responses: 200: - description: "tapi.common.TimePeriod" + description: "tapi.connectivity.ConnectivityServiceEndPointRef" schema: - $ref: "#/definitions/tapi.common.TimePeriod" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" 400: description: "Internal error" post: tags: - "tapi-oam" - description: "creates tapi.common.TimePeriod" + summary: "creates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-service-point" required: true type: "string" - in: "body" - name: "tapi.common.TimePeriod.body-param" - description: "tapi.common.TimePeriod to be added to list" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ to list" required: false schema: - $ref: "#/definitions/tapi.common.TimePeriod" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" responses: 201: description: "Object created" @@ -6265,24 +6457,26 @@ paths: put: tags: - "tapi-oam" - description: "creates or updates tapi.common.TimePeriod" + summary: "creates or updates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-service-point" required: true type: "string" - in: "body" - name: "tapi.common.TimePeriod.body-param" - description: "tapi.common.TimePeriod to be added or updated" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ or updated" required: false schema: - $ref: "#/definitions/tapi.common.TimePeriod" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" responses: 201: description: "Object created" @@ -6293,16 +6487,17 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.common.TimePeriod" + summary: "removes tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-service-point" required: true type: "string" responses: @@ -6310,81 +6505,71 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/name/: - post: + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/mep/: + get: tags: - "tapi-oam" - description: "creates tapi.common.NameAndValue" + summary: "returns tapi.oam.MepRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-service-point" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.oam.MepRef" + schema: + $ref: "#/definitions/tapi.oam.MepRef" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/name={value-name}/: + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/mip/: get: tags: - "tapi-oam" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.oam.MipRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of oam-service-point" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.oam.MipRef" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.oam.MipRef" 400: description: "Internal error" + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/name/: post: tags: - "tapi-oam" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of oam-service-point" required: true type: "string" - in: "body" @@ -6400,19 +6585,23 @@ paths: description: "Internal error" 409: description: "Object already exists" - put: + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/name={value-name}/: + get: tags: - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-service-point" required: true type: "string" - name: "value-name" @@ -6420,32 +6609,29 @@ paths: description: "Id of name" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + put: tags: - "tapi-oam" - description: "removes tapi.common.NameAndValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-service-point" required: true type: "string" - name: "value-name" @@ -6453,102 +6639,40 @@ paths: description: "Id of name" required: true type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-service/: - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamService" - parameters: - in: "body" - name: "tapi.oam.OamService.body-param" - description: "tapi.oam.OamService to be added to list" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.oam.OamService" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-service={uuid}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.OamService" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.OamService" - schema: - $ref: "#/definitions/tapi.oam.OamService" - 400: - description: "Internal error" - post: + 204: + description: "Object modified" + delete: tags: - "tapi-oam" - description: "creates tapi.oam.OamService" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of oam-service" required: true type: "string" - - in: "body" - name: "tapi.oam.OamService.body-param" - description: "tapi.oam.OamService to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamService" - parameters: - - name: "uuid" + - name: "local-id" in: "path" - description: "Id of oam-service" + description: "Id of oam-service-point" required: true type: "string" - - in: "body" - name: "tapi.oam.OamService.body-param" - description: "tapi.oam.OamService to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.OamService" - parameters: - - name: "uuid" + - name: "value-name" in: "path" - description: "Id of oam-service" + description: "Id of name" required: true type: "string" responses: @@ -6556,35 +6680,12 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/end-point/: - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamServiceEndPoint.body-param" - description: "tapi.oam.OamServiceEndPoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/: + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/service-interface-point/: get: tags: - "tapi-oam" - description: "returns tapi.oam.OamServiceEndPoint" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -6593,20 +6694,21 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of oam-service-point" required: true type: "string" responses: 200: - description: "tapi.oam.OamServiceEndPoint" + description: "tapi.common.ServiceInterfacePointRef" schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" 400: description: "Internal error" post: tags: - "tapi-oam" - description: "creates tapi.oam.OamServiceEndPoint" + summary: "creates tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -6615,15 +6717,15 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of oam-service-point" required: true type: "string" - in: "body" - name: "tapi.oam.OamServiceEndPoint.body-param" - description: "tapi.oam.OamServiceEndPoint to be added to list" + name: "tapi.common.ServiceInterfacePointRef.body-param" + description: "tapi.common.ServiceInterfacePointRef to be added to list" required: false schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" responses: 201: description: "Object created" @@ -6634,7 +6736,8 @@ paths: put: tags: - "tapi-oam" - description: "creates or updates tapi.oam.OamServiceEndPoint" + summary: "creates or updates tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -6643,15 +6746,15 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of oam-service-point" required: true type: "string" - in: "body" - name: "tapi.oam.OamServiceEndPoint.body-param" - description: "tapi.oam.OamServiceEndPoint to be added or updated" + name: "tapi.common.ServiceInterfacePointRef.body-param" + description: "tapi.common.ServiceInterfacePointRef to be added or updated" required: false schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" responses: 201: description: "Object created" @@ -6662,7 +6765,8 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.oam.OamServiceEndPoint" + summary: "removes tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -6671,7 +6775,7 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of oam-service-point" required: true type: "string" responses: @@ -6679,51 +6783,33 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/connectivity-service-end-point/: + /data/context/path-computation-context/: get: tags: - - "tapi-oam" - description: "returns tapi.connectivity.ConnectivityServiceEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" + - "tapi-path-computation" + summary: "returns tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" + parameters: [] responses: 200: - description: "tapi.connectivity.ConnectivityServiceEndPointRef" + description: "tapi.path.computation.PathComputationContext" schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" + $ref: "#/definitions/tapi.path.computation.PathComputationContext" 400: description: "Internal error" post: tags: - - "tapi-oam" - description: "creates tapi.connectivity.ConnectivityServiceEndPointRef" + - "tapi-path-computation" + summary: "creates tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - in: "body" - name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" - description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ - \ to list" + name: "tapi.path.computation.PathComputationContext.body-param" + description: "tapi.path.computation.PathComputationContext to be added to\ + \ list" required: false schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" + $ref: "#/definitions/tapi.path.computation.PathComputationContext" responses: 201: description: "Object created" @@ -6733,26 +6819,93 @@ paths: description: "Object already exists" put: tags: - - "tapi-oam" - description: "creates or updates tapi.connectivity.ConnectivityServiceEndPointRef" + - "tapi-path-computation" + summary: "creates or updates tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" + parameters: + - in: "body" + name: "tapi.path.computation.PathComputationContext.body-param" + description: "tapi.path.computation.PathComputationContext to be added or\ + \ updated" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.PathComputationContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.path.computation.PathComputationService" + description: "none" + parameters: + - in: "body" + name: "tapi.path.computation.PathComputationService.body-param" + description: "tapi.path.computation.PathComputationService to be added to\ + \ list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.PathComputationService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.path.computation.PathComputationService" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + responses: + 200: + description: "tapi.path.computation.PathComputationService" + schema: + $ref: "#/definitions/tapi.path.computation.PathComputationService" + 400: + description: "Internal error" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.path.computation.PathComputationService" + description: "none" + parameters: + - name: "uuid" in: "path" - description: "Id of end-point" + description: "Id of path-comp-service" required: true type: "string" - in: "body" - name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" - description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ - \ or updated" + name: "tapi.path.computation.PathComputationService.body-param" + description: "tapi.path.computation.PathComputationService to be added or\ + \ updated" required: false schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" + $ref: "#/definitions/tapi.path.computation.PathComputationService" responses: 201: description: "Object created" @@ -6762,17 +6915,13 @@ paths: description: "Object modified" delete: tags: - - "tapi-oam" - description: "removes tapi.connectivity.ConnectivityServiceEndPointRef" + - "tapi-path-computation" + summary: "removes tapi.path.computation.PathComputationService" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" + description: "Id of path-comp-service" required: true type: "string" responses: @@ -6780,38 +6929,41 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/mep/: - get: + /data/context/path-computation-context/path-comp-service={uuid}/end-point/: + post: tags: - - "tapi-oam" - description: "returns tapi.oam.MepRef" + - "tapi-path-computation" + summary: "creates tapi.path.computation.PathServiceEndPoint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" + description: "Id of path-comp-service" required: true type: "string" + - in: "body" + name: "tapi.path.computation.PathServiceEndPoint.body-param" + description: "tapi.path.computation.PathServiceEndPoint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" responses: - 200: - description: "tapi.oam.MepRef" - schema: - $ref: "#/definitions/tapi.oam.MepRef" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/mip/: + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/: get: tags: - - "tapi-oam" - description: "returns tapi.oam.MipRef" + - "tapi-path-computation" + summary: "returns tapi.path.computation.PathServiceEndPoint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" - name: "local-id" @@ -6821,20 +6973,20 @@ paths: type: "string" responses: 200: - description: "tapi.oam.MipRef" + description: "tapi.path.computation.PathServiceEndPoint" schema: - $ref: "#/definitions/tapi.oam.MipRef" + $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" 400: description: "Internal error" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/name/: - post: + put: tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" + - "tapi-path-computation" + summary: "creates or updates tapi.path.computation.PathServiceEndPoint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" - name: "local-id" @@ -6843,27 +6995,27 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.path.computation.PathServiceEndPoint.body-param" + description: "tapi.path.computation.PathServiceEndPoint to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" responses: 201: description: "Object created" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/name={value-name}/: - get: + 204: + description: "Object modified" + delete: tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" + - "tapi-path-computation" + summary: "removes tapi.path.computation.PathServiceEndPoint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" - name: "local-id" @@ -6871,26 +7023,44 @@ paths: description: "Id of end-point" required: true type: "string" - - name: "value-name" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.Capacity" + description: "none" + parameters: + - name: "uuid" in: "path" - description: "Id of name" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" post: tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" + - "tapi-path-computation" + summary: "creates tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" - name: "local-id" @@ -6898,17 +7068,12 @@ paths: description: "Id of end-point" required: true type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.common.Capacity.body-param" + description: "tapi.common.Capacity to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.common.Capacity" responses: 201: description: "Object created" @@ -6918,12 +7083,13 @@ paths: description: "Object already exists" put: tags: - - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" + - "tapi-path-computation" + summary: "creates or updates tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" - name: "local-id" @@ -6931,17 +7097,12 @@ paths: description: "Id of end-point" required: true type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" + name: "tapi.common.Capacity.body-param" + description: "tapi.common.Capacity to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.common.Capacity" responses: 201: description: "Object created" @@ -6951,12 +7112,13 @@ paths: description: "Object modified" delete: tags: - - "tapi-oam" - description: "removes tapi.common.NameAndValue" + - "tapi-path-computation" + summary: "removes tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" - name: "local-id" @@ -6964,25 +7126,22 @@ paths: description: "Id of end-point" required: true type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/service-interface-point/: + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/total-size/: get: tags: - - "tapi-oam" - description: "returns tapi.common.ServiceInterfacePointRef" + - "tapi-path-computation" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" - name: "local-id" @@ -6992,19 +7151,21 @@ paths: type: "string" responses: 200: - description: "tapi.common.ServiceInterfacePointRef" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" post: tags: - - "tapi-oam" - description: "creates tapi.common.ServiceInterfacePointRef" + - "tapi-path-computation" + summary: "creates tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" - name: "local-id" @@ -7013,11 +7174,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.ServiceInterfacePointRef.body-param" - description: "tapi.common.ServiceInterfacePointRef to be added to list" + name: "tapi.common.CapacityValue.body-param" + description: "tapi.common.CapacityValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + $ref: "#/definitions/tapi.common.CapacityValue" responses: 201: description: "Object created" @@ -7027,12 +7188,14 @@ paths: description: "Object already exists" put: tags: - - "tapi-oam" - description: "creates or updates tapi.common.ServiceInterfacePointRef" + - "tapi-path-computation" + summary: "creates or updates tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" - name: "local-id" @@ -7041,11 +7204,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.ServiceInterfacePointRef.body-param" - description: "tapi.common.ServiceInterfacePointRef to be added or updated" + name: "tapi.common.CapacityValue.body-param" + description: "tapi.common.CapacityValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + $ref: "#/definitions/tapi.common.CapacityValue" responses: 201: description: "Object created" @@ -7055,12 +7218,14 @@ paths: description: "Object modified" delete: tags: - - "tapi-oam" - description: "removes tapi.common.ServiceInterfacePointRef" + - "tapi-path-computation" + summary: "removes tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" - name: "local-id" @@ -7073,33 +7238,23 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/meg/: - get: + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/name/: + post: tags: - - "tapi-oam" - description: "returns tapi.oam.MegRef" + - "tapi-path-computation" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" - responses: - 200: - description: "tapi.oam.MegRef" - schema: - $ref: "#/definitions/tapi.oam.MegRef" - 400: - description: "Internal error" - /data/context/oam-context/oam-service={uuid}/name/: - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" + - name: "local-id" in: "path" - description: "Id of oam-service" + description: "Id of end-point" required: true type: "string" - in: "body" @@ -7115,15 +7270,23 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/oam-context/oam-service={uuid}/name={value-name}/: + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/name={value-name}/: get: tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" + - "tapi-path-computation" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" required: true type: "string" - name: "value-name" @@ -7138,42 +7301,22 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: + put: tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" + - "tapi-path-computation" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of path-comp-service" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" + - name: "local-id" in: "path" - description: "Id of oam-service" + description: "Id of end-point" required: true type: "string" - name: "value-name" @@ -7196,12 +7339,20 @@ paths: description: "Object modified" delete: tags: - - "tapi-oam" - description: "removes tapi.common.NameAndValue" + - "tapi-path-computation" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" required: true type: "string" - name: "value-name" @@ -7214,40 +7365,52 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/oam-profile/: + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/service-interface-point/: get: tags: - - "tapi-oam" - description: "returns tapi.oam.OamProfileRef" + - "tapi-path-computation" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" required: true type: "string" responses: 200: - description: "tapi.oam.OamProfileRef" + description: "tapi.common.ServiceInterfacePointRef" schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" 400: description: "Internal error" post: tags: - - "tapi-oam" - description: "creates tapi.oam.OamProfileRef" + - "tapi-path-computation" + summary: "creates tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" required: true type: "string" - in: "body" - name: "tapi.oam.OamProfileRef.body-param" - description: "tapi.oam.OamProfileRef to be added to list" + name: "tapi.common.ServiceInterfacePointRef.body-param" + description: "tapi.common.ServiceInterfacePointRef to be added to list" required: false schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" responses: 201: description: "Object created" @@ -7257,20 +7420,26 @@ paths: description: "Object already exists" put: tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamProfileRef" + - "tapi-path-computation" + summary: "creates or updates tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" required: true type: "string" - in: "body" - name: "tapi.oam.OamProfileRef.body-param" - description: "tapi.oam.OamProfileRef to be added or updated" + name: "tapi.common.ServiceInterfacePointRef.body-param" + description: "tapi.common.ServiceInterfacePointRef to be added or updated" required: false schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" responses: 201: description: "Object created" @@ -7280,12 +7449,18 @@ paths: description: "Object modified" delete: tags: - - "tapi-oam" - description: "removes tapi.oam.OamProfileRef" + - "tapi-path-computation" + summary: "removes tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" required: true type: "string" responses: @@ -7293,31 +7468,26 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathComputationContext" - parameters: [] - responses: - 200: - description: "tapi.path.computation.PathComputationContext" - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationContext" - 400: - description: "Internal error" + /data/context/path-computation-context/path-comp-service={uuid}/name/: post: tags: - "tapi-path-computation" - description: "creates tapi.path.computation.PathComputationContext" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" - in: "body" - name: "tapi.path.computation.PathComputationContext.body-param" - description: "tapi.path.computation.PathComputationContext to be added to\ - \ list" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.path.computation.PathComputationContext" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -7325,18 +7495,56 @@ paths: description: "Internal error" 409: description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/name={value-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" put: tags: - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathComputationContext" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" - in: "body" - name: "tapi.path.computation.PathComputationContext.body-param" - description: "tapi.path.computation.PathComputationContext to be added or\ - \ updated" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.path.computation.PathComputationContext" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -7347,38 +7555,32 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.path.computation.PathComputationContext" - parameters: [] + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathComputationService" - parameters: - - in: "body" - name: "tapi.path.computation.PathComputationService.body-param" - description: "tapi.path.computation.PathComputationService to be added to\ - \ list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/: + /data/context/path-computation-context/path-comp-service={uuid}/objective-function/: get: tags: - "tapi-path-computation" - description: "returns tapi.path.computation.PathComputationService" + summary: "returns tapi.path.computation.PathObjectiveFunction" + description: "none" parameters: - name: "uuid" in: "path" @@ -7387,15 +7589,16 @@ paths: type: "string" responses: 200: - description: "tapi.path.computation.PathComputationService" + description: "tapi.path.computation.PathObjectiveFunction" schema: - $ref: "#/definitions/tapi.path.computation.PathComputationService" + $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" 400: description: "Internal error" post: tags: - "tapi-path-computation" - description: "creates tapi.path.computation.PathComputationService" + summary: "creates tapi.path.computation.PathObjectiveFunction" + description: "none" parameters: - name: "uuid" in: "path" @@ -7403,12 +7606,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.path.computation.PathComputationService.body-param" - description: "tapi.path.computation.PathComputationService to be added to\ - \ list" + name: "tapi.path.computation.PathObjectiveFunction.body-param" + description: "tapi.path.computation.PathObjectiveFunction to be added to list" required: false schema: - $ref: "#/definitions/tapi.path.computation.PathComputationService" + $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" responses: 201: description: "Object created" @@ -7419,7 +7621,8 @@ paths: put: tags: - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathComputationService" + summary: "creates or updates tapi.path.computation.PathObjectiveFunction" + description: "none" parameters: - name: "uuid" in: "path" @@ -7427,12 +7630,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.path.computation.PathComputationService.body-param" - description: "tapi.path.computation.PathComputationService to be added or\ - \ updated" + name: "tapi.path.computation.PathObjectiveFunction.body-param" + description: "tapi.path.computation.PathObjectiveFunction to be added or updated" required: false schema: - $ref: "#/definitions/tapi.path.computation.PathComputationService" + $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" responses: 201: description: "Object created" @@ -7443,7 +7645,8 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.path.computation.PathComputationService" + summary: "removes tapi.path.computation.PathObjectiveFunction" + description: "none" parameters: - name: "uuid" in: "path" @@ -7455,11 +7658,14 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point/: + /data/context/path-computation-context/path-comp-service={uuid}/objective-function/name/: post: tags: - "tapi-path-computation" - description: "creates tapi.path.computation.PathServiceEndPoint" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -7467,11 +7673,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.path.computation.PathServiceEndPoint.body-param" - description: "tapi.path.computation.PathServiceEndPoint to be added to list" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -7479,78 +7685,56 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/: + /data/context/path-computation-context/path-comp-service={uuid}/objective-function/name={value-name}/: get: tags: - "tapi-path-computation" - description: "returns tapi.path.computation.PathServiceEndPoint" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of end-point" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.path.computation.PathServiceEndPoint" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathServiceEndPoint.body-param" - description: "tapi.path.computation.PathServiceEndPoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" - responses: - 201: - description: "Object created" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathServiceEndPoint" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of end-point" + description: "Id of name" required: true type: "string" - in: "body" - name: "tapi.path.computation.PathServiceEndPoint.body-param" - description: "tapi.path.computation.PathServiceEndPoint to be added or updated" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -7561,16 +7745,19 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.path.computation.PathServiceEndPoint" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of end-point" + description: "Id of name" required: true type: "string" responses: @@ -7578,50 +7765,43 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/: + /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/: get: tags: - "tapi-path-computation" - description: "returns tapi.common.Capacity" + summary: "returns tapi.path.computation.PathOptimizationConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" responses: 200: - description: "tapi.common.Capacity" + description: "tapi.path.computation.PathOptimizationConstraint" schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" 400: description: "Internal error" post: tags: - "tapi-path-computation" - description: "creates tapi.common.Capacity" + summary: "creates tapi.path.computation.PathOptimizationConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - in: "body" - name: "tapi.common.Capacity.body-param" - description: "tapi.common.Capacity to be added to list" + name: "tapi.path.computation.PathOptimizationConstraint.body-param" + description: "tapi.path.computation.PathOptimizationConstraint to be added\ + \ to list" required: false schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" responses: 201: description: "Object created" @@ -7632,24 +7812,21 @@ paths: put: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.Capacity" + summary: "creates or updates tapi.path.computation.PathOptimizationConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - in: "body" - name: "tapi.common.Capacity.body-param" - description: "tapi.common.Capacity to be added or updated" + name: "tapi.path.computation.PathOptimizationConstraint.body-param" + description: "tapi.path.computation.PathOptimizationConstraint to be added\ + \ or updated" required: false schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" responses: 201: description: "Object created" @@ -7660,95 +7837,96 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.common.Capacity" + summary: "removes tapi.path.computation.PathOptimizationConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/: - get: + /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name/: + post: tags: - "tapi-path-computation" - description: "returns tapi.common.BandwidthProfile" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name={value-name}/: + get: tags: - "tapi-path-computation" - description: "creates tapi.common.BandwidthProfile" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of end-point" + description: "Id of name" required: true type: "string" - - in: "body" - name: "tapi.common.BandwidthProfile.body-param" - description: "tapi.common.BandwidthProfile to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" responses: - 201: - description: "Object created" + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.BandwidthProfile" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of end-point" + description: "Id of name" required: true type: "string" - in: "body" - name: "tapi.common.BandwidthProfile.body-param" - description: "tapi.common.BandwidthProfile to be added or updated" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -7759,16 +7937,19 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.common.BandwidthProfile" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of end-point" + description: "Id of name" required: true type: "string" responses: @@ -7776,50 +7957,66 @@ paths: description: "Internal error" 204: description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-burst-size/ - : get: + /data/context/path-computation-context/path-comp-service={uuid}/path={path-uuid}/: + get: tags: - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.path.computation.PathRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "path-uuid" in: "path" - description: "Id of end-point" + description: "Id of path" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.path.computation.PathRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.path.computation.PathRef" 400: description: "Internal error" - post: + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/: + get: tags: - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" + summary: "returns tapi.path.computation.RoutingConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + responses: + 200: + description: "tapi.path.computation.RoutingConstraint" + schema: + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + 400: + description: "Internal error" + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" in: "path" - description: "Id of end-point" + description: "Id of path-comp-service" required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.path.computation.RoutingConstraint.body-param" + description: "tapi.path.computation.RoutingConstraint to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" responses: 201: description: "Object created" @@ -7830,24 +8027,20 @@ paths: put: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.path.computation.RoutingConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.path.computation.RoutingConstraint.body-param" + description: "tapi.path.computation.RoutingConstraint to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" responses: 201: description: "Object created" @@ -7858,95 +8051,93 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.path.computation.RoutingConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" in: "path" - description: "Id of end-point" + description: "Id of path-comp-service" required: true type: "string" + - in: "body" + name: "tapi.topology.CostCharacteristic.body-param" + description: "tapi.topology.CostCharacteristic to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" responses: + 201: + description: "Object created" 400: description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-information-rate/ - : get: + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic={cost-name}/: + get: tags: - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "cost-name" in: "path" - description: "Id of end-point" + description: "Id of cost-characteristic" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.CostCharacteristic" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.CostCharacteristic" 400: description: "Internal error" - post: + put: tags: - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" + summary: "creates or updates tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" + - name: "cost-name" in: "path" - description: "Id of end-point" + description: "Id of cost-characteristic" required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.topology.CostCharacteristic.body-param" + description: "tapi.topology.CostCharacteristic to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.CostCharacteristic" responses: 201: description: "Object created" @@ -7957,16 +8148,18 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "cost-name" in: "path" - description: "Id of end-point" + description: "Id of cost-characteristic" required: true type: "string" responses: @@ -7974,78 +8167,80 @@ paths: description: "Internal error" 204: description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-burst-size/ - : get: + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/latency-characteristic/: + post: tags: - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" + summary: "creates tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" + - in: "body" + name: "tapi.topology.LatencyCharacteristic.body-param" + description: "tapi.topology.LatencyCharacteristic to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + ? /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/ + : get: tags: - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "traffic-property-name" in: "path" - description: "Id of end-point" + description: "Id of latency-characteristic" required: true type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "traffic-property-name" in: "path" - description: "Id of end-point" + description: "Id of latency-characteristic" required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.topology.LatencyCharacteristic.body-param" + description: "tapi.topology.LatencyCharacteristic to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" responses: 201: description: "Object created" @@ -8056,16 +8251,18 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "traffic-property-name" in: "path" - description: "Id of end-point" + description: "Id of latency-characteristic" required: true type: "string" responses: @@ -8073,78 +8270,77 @@ paths: description: "Internal error" 204: description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-information-rate/ - : get: + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/risk-diversity-characteristic/: + post: tags: - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" + summary: "creates tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" + - in: "body" + name: "tapi.topology.RiskCharacteristic.body-param" + description: "tapi.topology.RiskCharacteristic to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + ? /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/ + : get: tags: - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" + summary: "returns tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "risk-characteristic-name" in: "path" - description: "Id of end-point" + description: "Id of risk-diversity-characteristic" required: true type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.topology.RiskCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "risk-characteristic-name" in: "path" - description: "Id of end-point" + description: "Id of risk-diversity-characteristic" required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.topology.RiskCharacteristic.body-param" + description: "tapi.topology.RiskCharacteristic to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.RiskCharacteristic" responses: 201: description: "Object created" @@ -8155,16 +8351,17 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "risk-characteristic-name" in: "path" - description: "Id of end-point" + description: "Id of risk-diversity-characteristic" required: true type: "string" responses: @@ -8172,33 +8369,37 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/total-size/: - get: + /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/: + post: tags: - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" + summary: "creates tapi.path.computation.TopologyConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" + - in: "body" + name: "tapi.path.computation.TopologyConstraint.body-param" + description: "tapi.path.computation.TopologyConstraint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint={local-id}/: + get: tags: - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" + summary: "returns tapi.path.computation.TopologyConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -8207,26 +8408,21 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of topology-constraint" required: true type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.path.computation.TopologyConstraint" + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.path.computation.TopologyConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -8235,15 +8431,15 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of topology-constraint" required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.path.computation.TopologyConstraint.body-param" + description: "tapi.path.computation.TopologyConstraint to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" responses: 201: description: "Object created" @@ -8254,7 +8450,8 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.path.computation.TopologyConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -8263,7 +8460,7 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of topology-constraint" required: true type: "string" responses: @@ -8271,11 +8468,14 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/name/: + /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint={local-id}/name/: post: tags: - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -8284,7 +8484,7 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of topology-constraint" required: true type: "string" - in: "body" @@ -8300,11 +8500,14 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/name={value-name}/: + /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint={local-id}/name={value-name}/: get: tags: - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -8313,7 +8516,7 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of topology-constraint" required: true type: "string" - name: "value-name" @@ -8328,43 +8531,13 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -8373,7 +8546,7 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of topology-constraint" required: true type: "string" - name: "value-name" @@ -8397,7 +8570,10 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -8406,7 +8582,7 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of topology-constraint" required: true type: "string" - name: "value-name" @@ -8419,62 +8595,66 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/service-interface-point/: + /data/context/path-computation-context/path={uuid}/: get: tags: - "tapi-path-computation" - description: "returns tapi.common.ServiceInterfacePointRef" + summary: "returns tapi.path.computation.Path" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" + description: "Id of path" required: true type: "string" responses: 200: - description: "tapi.common.ServiceInterfacePointRef" + description: "tapi.path.computation.Path" schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + $ref: "#/definitions/tapi.path.computation.Path" 400: description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/name/: - post: + /data/context/path-computation-context/path={uuid}/link={topology-uuid},{link-uuid}/: + get: tags: - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" + summary: "returns tapi.topology.LinkRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of path" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.topology.LinkRef" + schema: + $ref: "#/definitions/tapi.topology.LinkRef" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/name={value-name}/: + /data/context/path-computation-context/path={uuid}/name={value-name}/: get: tags: - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of path" required: true type: "string" - name: "value-name" @@ -8489,116 +8669,112 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: + /data/context/path-computation-context/path={uuid}/routing-constraint/: + get: tags: - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" + summary: "returns tapi.path.computation.RoutingConstraint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of path" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.path.computation.RoutingConstraint" + schema: + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + /data/context/path-computation-context/path={uuid}/routing-constraint/cost-characteristic={cost-name}/: + get: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of path" required: true type: "string" - - name: "value-name" + - name: "cost-name" in: "path" - description: "Id of name" + description: "Id of cost-characteristic" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + /data/context/path-computation-context/path={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/: + get: tags: - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of path" required: true type: "string" - - name: "value-name" + - name: "traffic-property-name" in: "path" - description: "Id of name" + description: "Id of latency-characteristic" required: true type: "string" responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/objective-function/: + /data/context/path-computation-context/path={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/: get: tags: - "tapi-path-computation" - description: "returns tapi.path.computation.PathObjectiveFunction" + summary: "returns tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of path" + required: true + type: "string" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-diversity-characteristic" required: true type: "string" responses: 200: - description: "tapi.path.computation.PathObjectiveFunction" + description: "tapi.topology.RiskCharacteristic" schema: - $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" + $ref: "#/definitions/tapi.topology.RiskCharacteristic" 400: description: "Internal error" + /data/context/service-interface-point/: post: tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathObjectiveFunction" + - "tapi-common" + summary: "creates tapi.common.ServiceInterfacePoint" + description: "none" parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - in: "body" - name: "tapi.path.computation.PathObjectiveFunction.body-param" - description: "tapi.path.computation.PathObjectiveFunction to be added to list" + name: "tapi.common.ServiceInterfacePoint.body-param" + description: "tapi.common.ServiceInterfacePoint to be added to list" required: false schema: - $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" responses: 201: description: "Object created" @@ -8606,22 +8782,42 @@ paths: description: "Internal error" 409: description: "Object already exists" + /data/context/service-interface-point={uuid}/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.ServiceInterfacePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.ServiceInterfacePoint" + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + 400: + description: "Internal error" put: tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathObjectiveFunction" + - "tapi-common" + summary: "creates or updates tapi.common.ServiceInterfacePoint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of service-interface-point" required: true type: "string" - in: "body" - name: "tapi.path.computation.PathObjectiveFunction.body-param" - description: "tapi.path.computation.PathObjectiveFunction to be added or updated" + name: "tapi.common.ServiceInterfacePoint.body-param" + description: "tapi.common.ServiceInterfacePoint to be added or updated" required: false schema: - $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" responses: 201: description: "Object created" @@ -8631,12 +8827,13 @@ paths: description: "Object modified" delete: tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.PathObjectiveFunction" + - "tapi-common" + summary: "removes tapi.common.ServiceInterfacePoint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of service-interface-point" required: true type: "string" responses: @@ -8644,66 +8841,57 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/objective-function/name/: - post: + /data/context/service-interface-point={uuid}/available-capacity/: + get: tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" + - "tapi-common" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of service-interface-point" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/objective-function/name={value-name}/: + /data/context/service-interface-point={uuid}/available-capacity/total-size/: get: tags: - - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" + - "tapi-common" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of service-interface-point" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" + /data/context/service-interface-point={uuid}/name/: post: tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" + - "tapi-common" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of service-interface-point" required: true type: "string" - in: "body" @@ -8719,14 +8907,43 @@ paths: description: "Internal error" 409: description: "Object already exists" + /data/context/service-interface-point={uuid}/name={value-name}/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" put: tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" + - "tapi-common" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of service-interface-point" required: true type: "string" - name: "value-name" @@ -8749,12 +8966,15 @@ paths: description: "Object modified" delete: tags: - - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" + - "tapi-common" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of service-interface-point" required: true type: "string" - name: "value-name" @@ -8767,41 +8987,72 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/: + /data/context/service-interface-point={uuid}/total-potential-capacity/: get: tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathOptimizationConstraint" + - "tapi-common" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of service-interface-point" required: true type: "string" responses: 200: - description: "tapi.path.computation.PathOptimizationConstraint" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - post: + /data/context/service-interface-point={uuid}/total-potential-capacity/total-size/: + get: tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathOptimizationConstraint" + - "tapi-common" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of service-interface-point" required: true type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: [] + responses: + 200: + description: "tapi.topology.TopologyContext" + schema: + $ref: "#/definitions/tapi.topology.TopologyContext" + 400: + description: "Internal error" + post: + tags: + - "tapi-topology" + summary: "creates tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: - in: "body" - name: "tapi.path.computation.PathOptimizationConstraint.body-param" - description: "tapi.path.computation.PathOptimizationConstraint to be added\ - \ to list" + name: "tapi.topology.context.TopologyContext.body-param" + description: "tapi.topology.TopologyContext to be added to list" required: false schema: - $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" + $ref: "#/definitions/tapi.topology.TopologyContext" responses: 201: description: "Object created" @@ -8811,21 +9062,16 @@ paths: description: "Object already exists" put: tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathOptimizationConstraint" + - "tapi-topology" + summary: "creates or updates tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - in: "body" - name: "tapi.path.computation.PathOptimizationConstraint.body-param" - description: "tapi.path.computation.PathOptimizationConstraint to be added\ - \ or updated" + name: "tapi.topology.context.TopologyContext.body-param" + description: "tapi.topology.TopologyContext to be added or updated" required: false schema: - $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" + $ref: "#/definitions/tapi.topology.TopologyContext" responses: 201: description: "Object created" @@ -8835,54 +9081,38 @@ paths: description: "Object modified" delete: tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.PathOptimizationConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" + - "tapi-topology" + summary: "removes tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: [] responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name/: - post: + /data/context/topology-context/nw-topology-service/: + get: tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" + - "tapi-topology" + summary: "returns tapi.topology.NetworkTopologyService" + description: "none" + parameters: [] responses: - 201: - description: "Object created" + 200: + description: "tapi.topology.NetworkTopologyService" + schema: + $ref: "#/definitions/tapi.topology.NetworkTopologyService" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name={value-name}/: + /data/context/topology-context/nw-topology-service/name={value-name}/: get: tags: - - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - name: "value-name" in: "path" description: "Id of name" @@ -8895,3239 +9125,297 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: + /data/context/topology-context/nw-topology-service/topology={topology-uuid}/: + get: tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" + - "tapi-topology" + summary: "returns tapi.topology.TopologyRef" + description: "none" parameters: - - name: "uuid" + - name: "topology-uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of topology" required: true type: "string" - - name: "value-name" + responses: + 200: + description: "tapi.topology.TopologyRef" + schema: + $ref: "#/definitions/tapi.topology.TopologyRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.topologycontext.Topology" + description: "none" + parameters: + - name: "uuid" in: "path" - description: "Id of name" + description: "Id of topology" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.topology.Topology" + schema: + $ref: "#/definitions/tapi.topology.Topology" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + /data/context/topology-context/topology={uuid}/boundary-node-edge-point={topology-uuid},{node-uuid},{node-edge-point-uuid}/: + get: tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of topology" required: true type: "string" - - name: "value-name" + - name: "topology-uuid" in: "path" - description: "Id of name" + description: "Id of boundary-node-edge-point" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of boundary-node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of boundary-node-edge-point" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + /data/context/topology-context/topology={uuid}/link={link-uuid}/: + get: tags: - - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" + - "tapi-topology" + summary: "returns tapi.topology.Link" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of topology" required: true type: "string" - - name: "value-name" + - name: "link-uuid" in: "path" - description: "Id of name" + description: "Id of link" required: true type: "string" responses: + 200: + description: "tapi.topology.Link" + schema: + $ref: "#/definitions/tapi.topology.Link" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/path={path-uuid}/: + /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/: get: tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathRef" + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of topology" required: true type: "string" - - name: "path-uuid" + - name: "link-uuid" in: "path" - description: "Id of path" + description: "Id of link" required: true type: "string" responses: 200: - description: "tapi.path.computation.PathRef" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.path.computation.PathRef" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/: + /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/total-size/: get: tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.RoutingConstraint" + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" required: true type: "string" responses: 200: - description: "tapi.path.computation.RoutingConstraint" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - post: + /data/context/topology-context/topology={uuid}/link={link-uuid}/cost-characteristic={cost-name}/: + get: tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.RoutingConstraint" + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" required: true type: "string" - - in: "body" - name: "tapi.path.computation.RoutingConstraint.body-param" - description: "tapi.path.computation.RoutingConstraint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" responses: - 201: - description: "Object created" + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + /data/context/topology-context/topology={uuid}/link={link-uuid}/latency-characteristic={traffic-property-name}/: + get: tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.RoutingConstraint" + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of topology" required: true type: "string" - - in: "body" - name: "tapi.path.computation.RoutingConstraint.body-param" - description: "tapi.path.computation.RoutingConstraint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/latency-characteristic/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - ? /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/ - : get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/risk-diversity-characteristic/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - ? /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/ - : get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.TopologyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.TopologyConstraint" - schema: - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.TopologyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.TopologyConstraint.body-param" - description: "tapi.path.computation.TopologyConstraint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.TopologyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.TopologyConstraint.body-param" - description: "tapi.path.computation.TopologyConstraint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.TopologyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/avoid-topology={topology-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of avoid-topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/exclude-link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LinkRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of exclude-link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of exclude-link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/exclude-node={topology-uuid},{node-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.NodeRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of exclude-node" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of exclude-node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/exclude-path={path-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "path-uuid" - in: "path" - description: "Id of exclude-path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LinkRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of include-link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-node={topology-uuid},{node-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.NodeRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-node" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of include-node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-path={path-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "path-uuid" - in: "path" - description: "Id of include-path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-topology={topology-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.Path" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.Path" - schema: - $ref: "#/definitions/tapi.path.computation.Path" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LinkRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/name={value-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/routing-constraint/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.RoutingConstraint" - schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/routing-constraint/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - /data/context/service-interface-point/: - post: - tags: - - "tapi-common" - description: "creates tapi.common.ServiceInterfacePoint" - parameters: - - in: "body" - name: "tapi.common.ServiceInterfacePoint.body-param" - description: "tapi.common.ServiceInterfacePoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/service-interface-point={uuid}/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.ServiceInterfacePoint" - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.ServiceInterfacePoint.body-param" - description: "tapi.common.ServiceInterfacePoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.ServiceInterfacePoint.body-param" - description: "tapi.common.ServiceInterfacePoint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/service-interface-point={uuid}/available-capacity/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/committed-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/total-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/name/: - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/service-interface-point={uuid}/name={value-name}/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/service-interface-point={uuid}/total-potential-capacity/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/total-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.TopologyContext" - parameters: [] - responses: - 200: - description: "tapi.topology.TopologyContext" - schema: - $ref: "#/definitions/tapi.topology.TopologyContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-topology" - description: "creates tapi.topology.TopologyContext" - parameters: - - in: "body" - name: "tapi.topology.context.TopologyContext.body-param" - description: "tapi.topology.TopologyContext to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.TopologyContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-topology" - description: "creates or updates tapi.topology.TopologyContext" - parameters: - - in: "body" - name: "tapi.topology.context.TopologyContext.body-param" - description: "tapi.topology.TopologyContext to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.TopologyContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-topology" - description: "removes tapi.topology.TopologyContext" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/topology-context/nw-topology-service/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NetworkTopologyService" - parameters: [] - responses: - 200: - description: "tapi.topology.NetworkTopologyService" - schema: - $ref: "#/definitions/tapi.topology.NetworkTopologyService" - 400: - description: "Internal error" - /data/context/topology-context/nw-topology-service/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/topology-context/nw-topology-service/topology={topology-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "topology-uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Topology" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Topology" - schema: - $ref: "#/definitions/tapi.topology.Topology" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Link" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Link" - schema: - $ref: "#/definitions/tapi.topology.Link" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/latency-characteristic={traffic-property-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/node-edge-point={topology-uuid},{node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/resilience-type/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.ResilienceType" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.ResilienceType" - schema: - $ref: "#/definitions/tapi.topology.ResilienceType" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/risk-characteristic={risk-characteristic-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/validation-mechanism={validation-mechanism}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.ValidationMechanism" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "validation-mechanism" - in: "path" - description: "Id of validation-mechanism" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.ValidationMechanism" - schema: - $ref: "#/definitions/tapi.topology.ValidationMechanism" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.topology.Node" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.topology.Node" - schema: - $ref: "#/definitions/tapi.topology.topology.Node" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "aggregated-node-edge-point-node-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/encap-topology/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/latency-characteristic={traffic-property-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroup" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRuleGroup" - schema: - $ref: "#/definitions/tapi.topology.NodeRuleGroup" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/composed-rule-group={topology-uuid},{composed-rule-group-node-uuid},{composed-rule-group-node-rule-group-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroupRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of composed-rule-group" - required: true - type: "string" - - name: "composed-rule-group-node-uuid" - in: "path" - description: "Id of composed-rule-group" - required: true - type: "string" - - name: "composed-rule-group-node-rule-group-uuid" - in: "path" - description: "Id of composed-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRuleGroupRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/cost-characteristic={cost-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.InterRuleGroup" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.InterRuleGroup" - schema: - $ref: "#/definitions/tapi.topology.InterRuleGroup" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/associated-node-rule-group={topology-uuid},{associated-node-rule-group-node-uuid},{associated-node-rule-group-node-rule-group-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroupRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of associated-node-rule-group" - required: true - type: "string" - - name: "associated-node-rule-group-node-uuid" - in: "path" - description: "Id of associated-node-rule-group" - required: true - type: "string" - - name: "associated-node-rule-group-node-rule-group-uuid" - in: "path" - description: "Id of associated-node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRuleGroupRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/cost-characteristic={cost-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" + - name: "link-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of link" required: true type: "string" - - name: "cost-name" + - name: "traffic-property-name" in: "path" - description: "Id of cost-characteristic" + description: "Id of latency-characteristic" required: true type: "string" responses: 200: - description: "tapi.topology.CostCharacteristic" + description: "tapi.topology.LatencyCharacteristic" schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/latency-characteristic={traffic-property-name}/ - : get: + /data/context/topology-context/topology={uuid}/link={link-uuid}/name={value-name}/: + get: tags: - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" + - name: "link-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of link" required: true type: "string" - - name: "traffic-property-name" + - name: "value-name" in: "path" - description: "Id of latency-characteristic" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.topology.LatencyCharacteristic" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/name={value-name}/ + ? /data/context/topology-context/topology={uuid}/link={link-uuid}/node-edge-point={topology-uuid},{node-uuid},{node-edge-point-uuid}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "node-uuid" + - name: "link-uuid" in: "path" - description: "Id of node" + description: "Id of link" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "topology-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "node-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "value-name" + - name: "node-edge-point-uuid" in: "path" - description: "Id of name" + description: "Id of node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.topology.NodeEdgePointRef" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ - : get: + /data/context/topology-context/topology={uuid}/link={link-uuid}/risk-characteristic={risk-characteristic-name}/: + get: tags: - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" + - name: "link-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of link" required: true type: "string" - name: "risk-characteristic-name" @@ -12142,73 +9430,98 @@ paths: $ref: "#/definitions/tapi.topology.RiskCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/ - : get: + /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/: + get: tags: - "tapi-topology" - description: "returns tapi.topology.Rule" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" + - name: "link-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of link" required: true type: "string" - - name: "inter-rule-group-uuid" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/total-size/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of topology" required: true type: "string" - - name: "local-id" + - name: "link-uuid" in: "path" - description: "Id of rule" + description: "Id of link" required: true type: "string" responses: 200: - description: "tapi.topology.Rule" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.topology.Rule" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/name={value-name}/ - : get: + /data/context/topology-context/topology={uuid}/link={link-uuid}/validation-mechanism={validation-mechanism}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.topology.ValidationMechanism" + description: "Provides details of the specific validation mechanism(s) used\ + \ to confirm the presence of an intended topologicalEntity." parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" + - name: "link-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of link" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "validation-mechanism" in: "path" - description: "Id of inter-rule-group" + description: "Id of validation-mechanism" required: true type: "string" - - name: "local-id" + responses: + 200: + description: "tapi.topology.ValidationMechanism" + schema: + $ref: "#/definitions/tapi.topology.ValidationMechanism" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" in: "path" - description: "Id of rule" + description: "Id of topology" required: true type: "string" - name: "value-name" @@ -12223,11 +9536,12 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.Capacity" + summary: "returns tapi.topology.topology.Node" + description: "none" parameters: - name: "uuid" in: "path" @@ -12239,28 +9553,19 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" responses: 200: - description: "tapi.common.Capacity" + description: "tapi.topology.topology.Node" schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.topology.topology.Node" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -12272,28 +9577,34 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "topology-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of aggregated-node-edge-point" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "aggregated-node-edge-point-node-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.topology.NodeEdgePointRef" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" @@ -12305,14 +9616,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/total-size/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of topology" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "node-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of node" required: true type: "string" responses: @@ -12322,11 +9648,13 @@ paths: $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/cost-characteristic={cost-name}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" @@ -12338,28 +9666,24 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" + - name: "cost-name" in: "path" - description: "Id of inter-rule-group" + description: "Id of cost-characteristic" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.CostCharacteristic" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.CostCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/encap-topology/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.TopologyRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -12371,28 +9695,51 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + responses: + 200: + description: "tapi.topology.TopologyRef" + schema: + $ref: "#/definitions/tapi.topology.TopologyRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/latency-characteristic={traffic-property-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of topology" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "node-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of node" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.LatencyCharacteristic" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/name={value-name}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -12404,28 +9751,24 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" + - name: "value-name" in: "path" - description: "Id of inter-rule-group" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/total-size/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.node.NodeEdgePoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -12437,28 +9780,24 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.node.NodeEdgePoint" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.node.NodeEdgePoint" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/latency-characteristic={traffic-property-name}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{aggregated-node-edge-point-node-edge-point-uuid}/ : get: tags: - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -12470,28 +9809,39 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "traffic-property-name" + - name: "topology-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "aggregated-node-edge-point-node-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "aggregated-node-edge-point-node-edge-point-uuid" in: "path" - description: "Id of latency-characteristic" + description: "Id of aggregated-node-edge-point" required: true type: "string" responses: 200: - description: "tapi.topology.LatencyCharacteristic" + description: "tapi.topology.NodeEdgePointRef" schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/name={value-name}/: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-capacity/: get: tags: - "tapi-topology" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" @@ -12503,28 +9853,25 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "value-name" + - name: "node-edge-point-uuid" in: "path" - description: "Id of name" + description: "Id of node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/node-edge-point={topology-uuid},{node-edge-point-node-uuid},{node-edge-point-uuid}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-capacity/total-size/ : get: tags: - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -12536,21 +9883,6 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-edge-point-node-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - name: "node-edge-point-uuid" in: "path" description: "Id of node-edge-point" @@ -12558,16 +9890,17 @@ paths: type: "string" responses: 200: - description: "tapi.topology.NodeEdgePointRef" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-cep-layer-protocol={layer-protocol-qualifier}/ : get: tags: - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" + summary: "returns tapi.topology.NepLayerProtocolCapability" + description: "none" parameters: - name: "uuid" in: "path" @@ -12579,28 +9912,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "risk-characteristic-name" + - name: "layer-protocol-qualifier" in: "path" - description: "Id of risk-characteristic" + description: "Id of available-cep-layer-protocol" required: true type: "string" responses: 200: - description: "tapi.topology.RiskCharacteristic" + description: "tapi.topology.NepLayerProtocolCapability" schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" + $ref: "#/definitions/tapi.topology.NepLayerProtocolCapability" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/: get: tags: - - "tapi-topology" - description: "returns tapi.topology.Rule" + - "tapi-connectivity" + summary: "returns tapi.connectivity.context.topologycontext.topology.node.nodeedgepoint.CepList" + description: "none" parameters: - name: "uuid" in: "path" @@ -12612,28 +9946,24 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "local-id" + - name: "node-edge-point-uuid" in: "path" - description: "Id of rule" + description: "Id of node-edge-point" required: true type: "string" responses: 200: - description: "tapi.topology.Rule" + description: "tapi.connectivity.context.topologycontext.topology.node.nodeedgepoint.CepList" schema: - $ref: "#/definitions/tapi.topology.Rule" + $ref: "#/definitions/tapi.connectivity.context.topologycontext.topology.node.nodeedgepoint.CepList" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/name={value-name}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" + - "tapi-connectivity" + summary: "returns tapi.connectivity.ceplist.ConnectionEndPoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -12645,33 +9975,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "local-id" + - name: "node-edge-point-uuid" in: "path" - description: "Id of rule" + description: "Id of node-edge-point" required: true type: "string" - - name: "value-name" + - name: "connection-end-point-uuid" in: "path" - description: "Id of name" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.connectivity.ceplist.ConnectionEndPoint" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.connectivity.ceplist.ConnectionEndPoint" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/aggregated-connection-end-point={topology-uuid},{aggregated-connection-end-point-node-uuid},{aggregated-connection-end-point-node-edge-point-uuid},{aggregated-connection-end-point-connection-end-point-uuid}/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" + - "tapi-connectivity" + summary: "returns tapi.connectivity.ConnectionEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -12683,51 +10009,49 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" + - name: "connection-end-point-uuid" in: "path" - description: "Id of topology" + description: "Id of connection-end-point" required: true type: "string" - - name: "node-uuid" + - name: "topology-uuid" in: "path" - description: "Id of node" + description: "Id of aggregated-connection-end-point" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "aggregated-connection-end-point-node-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of aggregated-connection-end-point" + required: true + type: "string" + - name: "aggregated-connection-end-point-node-edge-point-uuid" + in: "path" + description: "Id of aggregated-connection-end-point" + required: true + type: "string" + - name: "aggregated-connection-end-point-connection-end-point-uuid" + in: "path" + description: "Id of aggregated-connection-end-point" required: true type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.connectivity.ConnectionEndPointRef" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.connectivity.ConnectionEndPointRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/client-node-edge-point={topology-uuid},{client-node-edge-point-node-uuid},{client-node-edge-point-node-edge-point-uuid}/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" + - "tapi-connectivity" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -12739,23 +10063,44 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of client-node-edge-point" + required: true + type: "string" + - name: "client-node-edge-point-node-uuid" + in: "path" + description: "Id of client-node-edge-point" + required: true + type: "string" + - name: "client-node-edge-point-node-edge-point-uuid" + in: "path" + description: "Id of client-node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.NodeEdgePointRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" + - "tapi-oam" + summary: "returns tapi.oam.MepMipList" + description: "none" parameters: - name: "uuid" in: "path" @@ -12767,23 +10112,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.oam.MepMipList" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.oam.MepMipList" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/mep={meg-uuid},{mep-local-id}/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" + - "tapi-oam" + summary: "returns tapi.oam.MepRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -12795,23 +10146,39 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "meg-uuid" + in: "path" + description: "Id of mep" + required: true + type: "string" + - name: "mep-local-id" + in: "path" + description: "Id of mep" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.oam.MepRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.oam.MepRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/mip={meg-uuid},{mip-local-id}/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" + - "tapi-oam" + summary: "returns tapi.oam.MipRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -12823,23 +10190,41 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "meg-uuid" + in: "path" + description: "Id of mip" + required: true + type: "string" + - name: "mip-local-id" + in: "path" + description: "Id of mip" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.oam.MipRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.oam.MipRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/total-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/name={value-name}/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" + - "tapi-connectivity" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -12851,23 +10236,34 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/: - get: + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/parent-node-edge-point/ + : get: tags: - - "tapi-topology" - description: "returns tapi.topology.node.OwnedNodeEdgePoint" + - "tapi-connectivity" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -12876,26 +10272,34 @@ paths: type: "string" - name: "node-uuid" in: "path" - description: "Id of node" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "connection-end-point-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.topology.node.OwnedNodeEdgePoint" + description: "tapi.topology.NodeEdgePointRef" schema: - $ref: "#/definitions/tapi.topology.node.OwnedNodeEdgePoint" + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/mapped-service-interface-point={service-interface-point-uuid}/ : get: tags: - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "NodeEdgePoint mapped to more than ServiceInterfacePoint (slicing/virtualizing)\ + \ or a ServiceInterfacePoint mapped to more than one NodeEdgePoint (load balancing/Resilience)\ + \ should be considered experimental" parameters: - name: "uuid" in: "path" @@ -12907,38 +10311,31 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "aggregated-node-edge-point-node-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of aggregated-node-edge-point" + description: "Id of node-edge-point" required: true type: "string" - - name: "node-edge-point-uuid" + - name: "service-interface-point-uuid" in: "path" - description: "Id of aggregated-node-edge-point" + description: "Id of mapped-service-interface-point" required: true type: "string" responses: 200: - description: "tapi.topology.NodeEdgePointRef" + description: "tapi.common.ServiceInterfacePointRef" schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/name={value-name}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.Capacity" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -12950,23 +10347,30 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "value-name" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.common.Capacity" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/total-potential-capacity/ : get: tags: - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" @@ -12978,23 +10382,25 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/total-potential-capacity/total-size/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -13006,9 +10412,9 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-edge-point" required: true type: "string" responses: @@ -13018,11 +10424,12 @@ paths: $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.NodeRuleGroup" + description: "none" parameters: - name: "uuid" in: "path" @@ -13034,23 +10441,24 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-rule-group" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.NodeRuleGroup" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.NodeRuleGroup" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" @@ -13062,23 +10470,25 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-rule-group" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/total-size/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -13090,9 +10500,9 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-rule-group" required: true type: "string" responses: @@ -13102,11 +10512,12 @@ paths: $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/total-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/composed-rule-group={topology-uuid},{composed-rule-group-node-uuid},{composed-rule-group-node-rule-group-uuid}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.NodeRuleGroupRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -13118,23 +10529,40 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of composed-rule-group" + required: true + type: "string" + - name: "composed-rule-group-node-uuid" + in: "path" + description: "Id of composed-rule-group" + required: true + type: "string" + - name: "composed-rule-group-node-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of composed-rule-group" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.NodeRuleGroupRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/: - get: + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/cost-characteristic={cost-name}/ + : get: tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.context.topologycontext.topology.node.ownednodeedgepoint.CepList" + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" @@ -13146,23 +10574,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "cost-name" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of cost-characteristic" required: true type: "string" responses: 200: - description: "tapi.connectivity.context.topologycontext.topology.node.ownednodeedgepoint.CepList" + description: "tapi.topology.CostCharacteristic" schema: - $ref: "#/definitions/tapi.connectivity.context.topologycontext.topology.node.ownednodeedgepoint.CepList" + $ref: "#/definitions/tapi.topology.CostCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/ : get: tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ceplist.ConnectionEndPoint" + - "tapi-topology" + summary: "returns tapi.topology.InterRuleGroup" + description: "none" parameters: - name: "uuid" in: "path" @@ -13174,28 +10608,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-rule-group" required: true type: "string" - - name: "connection-end-point-uuid" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of connection-end-point" + description: "Id of inter-rule-group" required: true type: "string" responses: 200: - description: "tapi.connectivity.ceplist.ConnectionEndPoint" + description: "tapi.topology.InterRuleGroup" schema: - $ref: "#/definitions/tapi.connectivity.ceplist.ConnectionEndPoint" + $ref: "#/definitions/tapi.topology.InterRuleGroup" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/aggregated-connection-end-point={topology-uuid},{aggregated-connection-end-point-node-uuid},{node-edge-point-uuid},{aggregated-connection-end-point-connection-end-point-uuid}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/associated-node-rule-group={topology-uuid},{associated-node-rule-group-node-uuid},{associated-node-rule-group-node-rule-group-uuid}/ : get: tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionEndPointRef" + - "tapi-topology" + summary: "returns tapi.topology.NodeRuleGroupRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -13207,48 +10642,44 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-rule-group" required: true type: "string" - - name: "connection-end-point-uuid" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of connection-end-point" + description: "Id of inter-rule-group" required: true type: "string" - name: "topology-uuid" in: "path" - description: "Id of aggregated-connection-end-point" - required: true - type: "string" - - name: "aggregated-connection-end-point-node-uuid" - in: "path" - description: "Id of aggregated-connection-end-point" + description: "Id of associated-node-rule-group" required: true type: "string" - - name: "node-edge-point-uuid" + - name: "associated-node-rule-group-node-uuid" in: "path" - description: "Id of aggregated-connection-end-point" + description: "Id of associated-node-rule-group" required: true type: "string" - - name: "aggregated-connection-end-point-connection-end-point-uuid" + - name: "associated-node-rule-group-node-rule-group-uuid" in: "path" - description: "Id of aggregated-connection-end-point" + description: "Id of associated-node-rule-group" required: true type: "string" responses: 200: - description: "tapi.connectivity.ConnectionEndPointRef" + description: "tapi.topology.NodeRuleGroupRef" schema: - $ref: "#/definitions/tapi.connectivity.ConnectionEndPointRef" + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/client-node-edge-point={topology-uuid},{client-node-edge-point-node-uuid},{node-edge-point-uuid}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/ : get: tags: - - "tapi-connectivity" - description: "returns tapi.topology.NodeEdgePointRef" + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" @@ -13260,43 +10691,30 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of client-node-edge-point" - required: true - type: "string" - - name: "client-node-edge-point-node-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of client-node-edge-point" + description: "Id of node-rule-group" required: true type: "string" - - name: "node-edge-point-uuid" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of client-node-edge-point" + description: "Id of inter-rule-group" required: true type: "string" responses: 200: - description: "tapi.topology.NodeEdgePointRef" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/total-size/ : get: tags: - - "tapi-oam" - description: "returns tapi.oam.MepMipList" + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -13308,28 +10726,30 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-rule-group" required: true type: "string" - - name: "connection-end-point-uuid" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of connection-end-point" + description: "Id of inter-rule-group" required: true type: "string" responses: 200: - description: "tapi.oam.MepMipList" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.oam.MepMipList" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/mep={meg-uuid},{mep-local-id}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/cost-characteristic={cost-name}/ : get: tags: - - "tapi-oam" - description: "returns tapi.oam.MepRef" + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" @@ -13341,38 +10761,35 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of connection-end-point" + description: "Id of node-rule-group" required: true type: "string" - - name: "meg-uuid" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of mep" + description: "Id of inter-rule-group" required: true type: "string" - - name: "mep-local-id" + - name: "cost-name" in: "path" - description: "Id of mep" + description: "Id of cost-characteristic" required: true type: "string" responses: 200: - description: "tapi.oam.MepRef" + description: "tapi.topology.CostCharacteristic" schema: - $ref: "#/definitions/tapi.oam.MepRef" + $ref: "#/definitions/tapi.topology.CostCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/mip={meg-uuid},{mip-local-id}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/latency-characteristic={traffic-property-name}/ : get: tags: - - "tapi-oam" - description: "returns tapi.oam.MipRef" + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" @@ -13384,38 +10801,36 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of connection-end-point" + description: "Id of node-rule-group" required: true type: "string" - - name: "meg-uuid" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of mip" + description: "Id of inter-rule-group" required: true type: "string" - - name: "mip-local-id" + - name: "traffic-property-name" in: "path" - description: "Id of mip" + description: "Id of latency-characteristic" required: true type: "string" responses: 200: - description: "tapi.oam.MipRef" + description: "tapi.topology.LatencyCharacteristic" schema: - $ref: "#/definitions/tapi.oam.MipRef" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/name={value-name}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/name={value-name}/ : get: tags: - - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -13427,14 +10842,14 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-rule-group" required: true type: "string" - - name: "connection-end-point-uuid" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of connection-end-point" + description: "Id of inter-rule-group" required: true type: "string" - name: "value-name" @@ -13449,11 +10864,13 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/parent-node-edge-point/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ : get: tags: - - "tapi-connectivity" - description: "returns tapi.topology.NodeEdgePointRef" + - "tapi-topology" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." parameters: - name: "uuid" in: "path" @@ -13465,28 +10882,34 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-rule-group" required: true type: "string" - - name: "connection-end-point-uuid" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of connection-end-point" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-characteristic" required: true type: "string" responses: 200: - description: "tapi.topology.NodeEdgePointRef" + description: "tapi.topology.RiskCharacteristic" schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + $ref: "#/definitions/tapi.topology.RiskCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/mapped-service-interface-point={service-interface-point-uuid}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.ServiceInterfacePointRef" + summary: "returns tapi.topology.Rule" + description: "none" parameters: - name: "uuid" in: "path" @@ -13498,28 +10921,36 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of inter-rule-group" required: true type: "string" - - name: "service-interface-point-uuid" + - name: "local-id" in: "path" - description: "Id of mapped-service-interface-point" + description: "Id of rule" required: true type: "string" responses: 200: - description: "tapi.common.ServiceInterfacePointRef" + description: "tapi.topology.Rule" schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + $ref: "#/definitions/tapi.topology.Rule" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/name={value-name}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/name={value-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -13531,9 +10962,19 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "local-id" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of rule" required: true type: "string" - name: "value-name" @@ -13548,11 +10989,13 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/ : get: tags: - "tapi-topology" - description: "returns tapi.common.Capacity" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" @@ -13564,9 +11007,14 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of inter-rule-group" required: true type: "string" responses: @@ -13576,11 +11024,13 @@ paths: $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/total-size/ : get: tags: - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -13592,23 +11042,30 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of inter-rule-group" required: true type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/latency-characteristic={traffic-property-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" @@ -13620,23 +11077,31 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "traffic-property-name" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of latency-characteristic" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.LatencyCharacteristic" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/name={value-name}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -13648,23 +11113,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "value-name" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/node-edge-point={topology-uuid},{node-edge-point-node-uuid},{node-edge-point-uuid}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -13676,51 +11147,40 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-rule-group" required: true type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" + - name: "topology-uuid" in: "path" - description: "Id of topology" + description: "Id of node-edge-point" required: true type: "string" - - name: "node-uuid" + - name: "node-edge-point-node-uuid" in: "path" - description: "Id of node" + description: "Id of node-edge-point" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.NodeEdgePointRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/total-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." parameters: - name: "uuid" in: "path" @@ -13732,23 +11192,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "risk-characteristic-name" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of risk-characteristic" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.RiskCharacteristic" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.RiskCharacteristic" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/: get: tags: - "tapi-topology" - description: "returns tapi.common.Capacity" + summary: "returns tapi.topology.Rule" + description: "none" parameters: - name: "uuid" in: "path" @@ -13760,41 +11226,31 @@ paths: description: "Id of node" required: true type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of topology" + description: "Id of node-rule-group" required: true type: "string" - - name: "node-uuid" + - name: "local-id" in: "path" - description: "Id of node" + description: "Id of rule" required: true type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.topology.Rule" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.topology.Rule" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/name={value-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -13806,18 +11262,35 @@ paths: description: "Id of node" required: true type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" @@ -13829,18 +11302,25 @@ paths: description: "Id of node" required: true type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/total-size/ + : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -13852,6 +11332,11 @@ paths: description: "Id of node" required: true type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" responses: 200: description: "tapi.common.CapacityValue" @@ -13859,11 +11344,13 @@ paths: $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" @@ -13877,16 +11364,18 @@ paths: type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/total-size/: get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -13909,6 +11398,8 @@ paths: post: tags: - "tapi-path-computation" + summary: "operates on tapi.path.computation.ComputeP2PPath" + description: "operates on tapi.path.computation.ComputeP2PPath" parameters: - in: "body" name: "tapi.path.computation.computep2ppath.Input.body-param" @@ -13930,6 +11421,8 @@ paths: post: tags: - "tapi-connectivity" + summary: "operates on tapi.connectivity.CreateConnectivityService" + description: "operates on tapi.connectivity.CreateConnectivityService" parameters: - in: "body" name: "tapi.connectivity.createconnectivityservice.Input.body-param" @@ -13951,6 +11444,8 @@ paths: post: tags: - "tapi-notification" + summary: "operates on tapi.notification.CreateNotificationSubscriptionService" + description: "operates on tapi.notification.CreateNotificationSubscriptionService" parameters: - in: "body" name: "tapi.notification.createnotificationsubscriptionservice.Input.body-param" @@ -13972,6 +11467,8 @@ paths: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.CreateOamJob" + description: "operates on tapi.oam.CreateOamJob" parameters: - in: "body" name: "tapi.oam.createoamjob.Input.body-param" @@ -13989,23 +11486,48 @@ paths: description: "No response" 400: description: "Internal error" - /operations/create-oam-service-end-point/: + /operations/create-oam-profile/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.CreateOamProfile" + description: "operates on tapi.oam.CreateOamProfile" + parameters: + - in: "body" + name: "tapi.oam.createoamprofile.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.createoamprofile.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.CreateOamProfile" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/create-oam-service-point/: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.CreateOamServicePoint" + description: "operates on tapi.oam.CreateOamServicePoint" parameters: - in: "body" - name: "tapi.oam.createoamserviceendpoint.Input.body-param" + name: "tapi.oam.createoamservicepoint.Input.body-param" required: false schema: properties: input: - $ref: "#/definitions/tapi.oam.createoamserviceendpoint.Input" + $ref: "#/definitions/tapi.oam.createoamservicepoint.Input" responses: 200: description: "Correct response" schema: - $ref: "#/definitions/tapi.oam.CreateOamServiceEndPoint" + $ref: "#/definitions/tapi.oam.CreateOamServicePoint" 201: description: "No response" 400: @@ -14014,6 +11536,8 @@ paths: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.CreateOamService" + description: "operates on tapi.oam.CreateOamService" parameters: - in: "body" name: "tapi.oam.createoamservice.Input.body-param" @@ -14035,6 +11559,8 @@ paths: post: tags: - "tapi-connectivity" + summary: "operates on tapi.connectivity.DeleteConnectivityService" + description: "operates on tapi.connectivity.DeleteConnectivityService" parameters: - in: "body" name: "tapi.connectivity.deleteconnectivityservice.Input.body-param" @@ -14052,6 +11578,8 @@ paths: post: tags: - "tapi-notification" + summary: "operates on tapi.notification.DeleteNotificationSubscriptionService" + description: "operates on tapi.notification.DeleteNotificationSubscriptionService" parameters: - in: "body" name: "tapi.notification.deletenotificationsubscriptionservice.Input.body-param" @@ -14061,10 +11589,6 @@ paths: input: $ref: "#/definitions/tapi.notification.deletenotificationsubscriptionservice.Input" responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.DeleteNotificationSubscriptionService" 201: description: "No response" 400: @@ -14073,6 +11597,8 @@ paths: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.DeleteOamJob" + description: "operates on tapi.oam.DeleteOamJob" parameters: - in: "body" name: "tapi.oam.deleteoamjob.Input.body-param" @@ -14086,18 +11612,39 @@ paths: description: "No response" 400: description: "Internal error" - /operations/delete-oam-service-end-point/: + /operations/delete-oam-profile/: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.DeleteOamProfile" + description: "operates on tapi.oam.DeleteOamProfile" parameters: - in: "body" - name: "tapi.oam.deleteoamserviceendpoint.Input.body-param" + name: "tapi.oam.deleteoamprofile.Input.body-param" required: false schema: properties: input: - $ref: "#/definitions/tapi.oam.deleteoamserviceendpoint.Input" + $ref: "#/definitions/tapi.oam.deleteoamprofile.Input" + responses: + 201: + description: "No response" + 400: + description: "Internal error" + /operations/delete-oam-service-point/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.DeleteOamServicePoint" + description: "operates on tapi.oam.DeleteOamServicePoint" + parameters: + - in: "body" + name: "tapi.oam.deleteoamservicepoint.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.deleteoamservicepoint.Input" responses: 201: description: "No response" @@ -14107,6 +11654,8 @@ paths: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.DeleteOamService" + description: "operates on tapi.oam.DeleteOamService" parameters: - in: "body" name: "tapi.oam.deleteoamservice.Input.body-param" @@ -14124,6 +11673,8 @@ paths: post: tags: - "tapi-path-computation" + summary: "operates on tapi.path.computation.DeleteP2PPath" + description: "operates on tapi.path.computation.DeleteP2PPath" parameters: - in: "body" name: "tapi.path.computation.deletep2ppath.Input.body-param" @@ -14145,6 +11696,8 @@ paths: post: tags: - "tapi-connectivity" + summary: "operates on tapi.connectivity.GetConnectionDetails" + description: "operates on tapi.connectivity.GetConnectionDetails" parameters: - in: "body" name: "tapi.connectivity.getconnectiondetails.Input.body-param" @@ -14166,6 +11719,8 @@ paths: post: tags: - "tapi-connectivity" + summary: "operates on tapi.connectivity.GetConnectionEndPointDetails" + description: "operates on tapi.connectivity.GetConnectionEndPointDetails" parameters: - in: "body" name: "tapi.connectivity.getconnectionendpointdetails.Input.body-param" @@ -14187,6 +11742,8 @@ paths: post: tags: - "tapi-connectivity" + summary: "operates on tapi.connectivity.GetConnectivityServiceDetails" + description: "operates on tapi.connectivity.GetConnectivityServiceDetails" parameters: - in: "body" name: "tapi.connectivity.getconnectivityservicedetails.Input.body-param" @@ -14222,6 +11779,8 @@ paths: post: tags: - "tapi-topology" + summary: "operates on tapi.topology.GetLinkDetails" + description: "operates on tapi.topology.GetLinkDetails" parameters: - in: "body" name: "tapi.topology.getlinkdetails.Input.body-param" @@ -14243,6 +11802,8 @@ paths: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.GetMeg" + description: "operates on tapi.oam.GetMeg" parameters: - in: "body" name: "tapi.oam.getmeg.Input.body-param" @@ -14264,6 +11825,8 @@ paths: post: tags: - "tapi-topology" + summary: "operates on tapi.topology.GetNodeDetails" + description: "operates on tapi.topology.GetNodeDetails" parameters: - in: "body" name: "tapi.topology.getnodedetails.Input.body-param" @@ -14285,6 +11848,8 @@ paths: post: tags: - "tapi-topology" + summary: "operates on tapi.topology.GetNodeEdgePointDetails" + description: "operates on tapi.topology.GetNodeEdgePointDetails" parameters: - in: "body" name: "tapi.topology.getnodeedgepointdetails.Input.body-param" @@ -14306,6 +11871,8 @@ paths: post: tags: - "tapi-notification" + summary: "operates on tapi.notification.GetNotificationList" + description: "operates on tapi.notification.GetNotificationList" parameters: - in: "body" name: "tapi.notification.getnotificationlist.Input.body-param" @@ -14327,6 +11894,8 @@ paths: post: tags: - "tapi-notification" + summary: "operates on tapi.notification.GetNotificationSubscriptionServiceDetails" + description: "operates on tapi.notification.GetNotificationSubscriptionServiceDetails" parameters: - in: "body" name: "tapi.notification.getnotificationsubscriptionservicedetails.Input.body-param" @@ -14358,10 +11927,26 @@ paths: description: "No response" 400: description: "Internal error" + /operations/get-oam-job-list/: + post: + tags: + - "tapi-oam" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetOamJobList" + 201: + description: "No response" + 400: + description: "Internal error" /operations/get-oam-job/: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.GetOamJob" + description: "operates on tapi.oam.GetOamJob" parameters: - in: "body" name: "tapi.oam.getoamjob.Input.body-param" @@ -14379,37 +11964,76 @@ paths: description: "No response" 400: description: "Internal error" - /operations/get-oam-service-end-point/: + /operations/get-oam-profile-list/: + post: + tags: + - "tapi-oam" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetOamProfileList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-oam-profile/: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.GetOamProfile" + description: "operates on tapi.oam.GetOamProfile" parameters: - in: "body" - name: "tapi.oam.getoamserviceendpoint.Input.body-param" + name: "tapi.oam.getoamprofile.Input.body-param" required: false schema: properties: input: - $ref: "#/definitions/tapi.oam.getoamserviceendpoint.Input" + $ref: "#/definitions/tapi.oam.getoamprofile.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetOamProfile" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-oam-service-list/: + post: + tags: + - "tapi-oam" + parameters: [] responses: 200: description: "Correct response" schema: - $ref: "#/definitions/tapi.oam.GetOamServiceEndPoint" + $ref: "#/definitions/tapi.oam.GetOamServiceList" 201: description: "No response" 400: description: "Internal error" - /operations/get-oam-service-list/: + /operations/get-oam-service-point/: post: tags: - "tapi-oam" - parameters: [] + summary: "operates on tapi.oam.GetOamServicePoint" + description: "operates on tapi.oam.GetOamServicePoint" + parameters: + - in: "body" + name: "tapi.oam.getoamservicepoint.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.getoamservicepoint.Input" responses: 200: description: "Correct response" schema: - $ref: "#/definitions/tapi.oam.GetOamServiceList" + $ref: "#/definitions/tapi.oam.GetOamServicePoint" 201: description: "No response" 400: @@ -14418,6 +12042,8 @@ paths: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.GetOamService" + description: "operates on tapi.oam.GetOamService" parameters: - in: "body" name: "tapi.oam.getoamservice.Input.body-param" @@ -14439,6 +12065,8 @@ paths: post: tags: - "tapi-common" + summary: "operates on tapi.common.GetServiceInterfacePointDetails" + description: "operates on tapi.common.GetServiceInterfacePointDetails" parameters: - in: "body" name: "tapi.common.getserviceinterfacepointdetails.Input.body-param" @@ -14488,6 +12116,8 @@ paths: post: tags: - "tapi-topology" + summary: "operates on tapi.topology.GetTopologyDetails" + description: "operates on tapi.topology.GetTopologyDetails" parameters: - in: "body" name: "tapi.topology.gettopologydetails.Input.body-param" @@ -14523,6 +12153,8 @@ paths: post: tags: - "tapi-path-computation" + summary: "operates on tapi.path.computation.OptimizeP2PPath" + description: "operates on tapi.path.computation.OptimizeP2PPath" parameters: - in: "body" name: "tapi.path.computation.optimizep2ppath.Input.body-param" @@ -14544,6 +12176,8 @@ paths: post: tags: - "tapi-connectivity" + summary: "operates on tapi.connectivity.UpdateConnectivityService" + description: "operates on tapi.connectivity.UpdateConnectivityService" parameters: - in: "body" name: "tapi.connectivity.updateconnectivityservice.Input.body-param" @@ -14565,6 +12199,8 @@ paths: post: tags: - "tapi-notification" + summary: "operates on tapi.notification.UpdateNotificationSubscriptionService" + description: "operates on tapi.notification.UpdateNotificationSubscriptionService" parameters: - in: "body" name: "tapi.notification.updatenotificationsubscriptionservice.Input.body-param" @@ -14586,6 +12222,8 @@ paths: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.UpdateOamJob" + description: "operates on tapi.oam.UpdateOamJob" parameters: - in: "body" name: "tapi.oam.updateoamjob.Input.body-param" @@ -14603,23 +12241,48 @@ paths: description: "No response" 400: description: "Internal error" - /operations/update-oam-service-end-point/: + /operations/update-oam-profile/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.UpdateOamProfile" + description: "operates on tapi.oam.UpdateOamProfile" + parameters: + - in: "body" + name: "tapi.oam.updateoamprofile.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.updateoamprofile.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.UpdateOamProfile" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/update-oam-service-point/: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.UpdateOamServicePoint" + description: "operates on tapi.oam.UpdateOamServicePoint" parameters: - in: "body" - name: "tapi.oam.updateoamserviceendpoint.Input.body-param" + name: "tapi.oam.updateoamservicepoint.Input.body-param" required: false schema: properties: input: - $ref: "#/definitions/tapi.oam.updateoamserviceendpoint.Input" + $ref: "#/definitions/tapi.oam.updateoamservicepoint.Input" responses: 200: description: "Correct response" schema: - $ref: "#/definitions/tapi.oam.UpdateOamServiceEndPoint" + $ref: "#/definitions/tapi.oam.UpdateOamServicePoint" 201: description: "No response" 400: @@ -14628,6 +12291,8 @@ paths: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.UpdateOamService" + description: "operates on tapi.oam.UpdateOamService" parameters: - in: "body" name: "tapi.oam.updateoamservice.Input.body-param" @@ -14649,6 +12314,8 @@ paths: post: tags: - "tapi-common" + summary: "operates on tapi.common.UpdateServiceInterfacePoint" + description: "operates on tapi.common.UpdateServiceInterfacePoint" parameters: - in: "body" name: "tapi.common.updateserviceinterfacepoint.Input.body-param" @@ -14680,45 +12347,9 @@ definitions: enum: - "LOCKED" - "UNLOCKED" - tapi.common.BandwidthProfile: - type: "object" - properties: - committed-information-rate: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - coupling-flag: - type: "boolean" - description: "none" - default: false - bw-profile-type: - description: "none" - $ref: "#/definitions/tapi.common.BandwidthProfileType" - peak-information-rate: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - committed-burst-size: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - peak-burst-size: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - color-aware: - type: "boolean" - description: "none" - default: false - tapi.common.BandwidthProfileType: - type: "string" - enum: - - "MEF_10.x" - - "RFC_2697" - - "RFC_2698" - - "RFC_4115" tapi.common.Capacity: type: "object" properties: - bandwidth-profile: - description: "none" - $ref: "#/definitions/tapi.common.BandwidthProfile" total-size: description: "Total capacity of the TopologicalEntity in MB/s. In case of\ \ bandwidthProfile, this is expected to same as the committedInformationRate." @@ -14761,8 +12392,8 @@ definitions: - $ref: "#/definitions/tapi.common.TapiContext" - $ref: "#/definitions/tapi.connectivity.ContextAugmentation4" - $ref: "#/definitions/tapi.notification.ContextAugmentation2" - - $ref: "#/definitions/tapi.oam.ContextAugmentation1" - - $ref: "#/definitions/tapi.path.computation.ContextAugmentation3" + - $ref: "#/definitions/tapi.oam.ContextAugmentation3" + - $ref: "#/definitions/tapi.path.computation.ContextAugmentation1" - $ref: "#/definitions/tapi.topology.ContextAugmentation5" tapi.common.DirectiveValue: type: "string" @@ -14793,21 +12424,21 @@ definitions: properties: name: type: "array" - description: "List of names. A property of an entity with a value that is\ - \ unique in some namespace but may change during the life of the entity.\ - \ A name carries no semantics with respect to the purpose of the entity." + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." items: $ref: "#/definitions/tapi.common.NameAndValue" uuid: type: "string" description: "UUID: An identifier that is universally unique within an identifier\ - \ space, where the identifier space is itself globally unique, and immutable.\ - \ An UUID carries no semantics with respect to the purpose or state of the\ - \ entity.\r\n UUID here uses string representation as\ - \ defined in RFC 4122. The canonical representation uses lowercase characters.\r\ - \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ - \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ - \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a UUID\ + \ in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.common.LayerProtocolName: type: "string" enum: @@ -14828,9 +12459,9 @@ definitions: properties: name: type: "array" - description: "List of names. A property of an entity with a value that is\ - \ unique in some namespace but may change during the life of the entity.\ - \ A name carries no semantics with respect to the purpose of the entity." + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." items: $ref: "#/definitions/tapi.common.NameAndValue" local-id: @@ -14892,7 +12523,7 @@ definitions: $ref: "#/definitions/tapi.common.LayerProtocolName" description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ \ termination and adaptation functions of one or more transport layers. \r\ - \n The structure of LTP supports all transport protocols including\ + \n The structure of LTP supports all transport protocols including\ \ circuit and packet forms." tapi.common.ServiceInterfacePointRef: type: "object" @@ -14926,11 +12557,11 @@ definitions: type: "object" properties: termination-direction: - description: "The overall directionality of the LP. \r\n \ - \ - A BIDIRECTIONAL LP will have some SINK and/or SOURCE flowss.\r\n \ - \ - A SINK LP can only contain elements with SINK flows\ - \ or CONTRA_DIRECTION_SOURCE flows\r\n - A SOURCE LP\ - \ can only contain SOURCE flows or CONTRA_DIRECTION_SINK flows" + description: "The overall directionality of the LP. \r\n -\ + \ A BIDIRECTIONAL LP will have some SINK and/or SOURCE flowss.\r\n \ + \ - A SINK LP can only contain elements with SINK flows or CONTRA_DIRECTION_SOURCE\ + \ flows\r\n - A SOURCE LP can only contain SOURCE flows or\ + \ CONTRA_DIRECTION_SINK flows" $ref: "#/definitions/tapi.common.TerminationDirection" termination-state: description: "Indicates whether the layer is terminated and if so how." @@ -14988,9 +12619,16 @@ definitions: tapi.common.getserviceinterfacepointdetails.Input: type: "object" properties: - sip-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.common.getserviceinterfacepointdetails.Output: type: "object" properties: @@ -15008,9 +12646,16 @@ definitions: tapi.common.updateserviceinterfacepoint.Input: type: "object" properties: - sip-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" state: description: "none" $ref: "#/definitions/tapi.common.AdministrativeState" @@ -15030,11 +12675,11 @@ definitions: description: "An Connection object supports a recursive aggregation relationship\ \ such that the internal construction of an Connection can be exposed\ \ as multiple lower level Connection objects (partitioning).\r\n \ - \ Aggregation is used as for the Node/Topology to allow\ - \ changes in hierarchy. \r\n Connection aggregation\ - \ reflects Node/Topology aggregation. \r\n The FC represents\ - \ a Cross-Connection in an NE. The Cross-Connection in an NE is not necessarily\ - \ the lowest level of FC partitioning." + \ Aggregation is used as for the Node/Topology to allow changes\ + \ in hierarchy. \r\n Connection aggregation reflects Node/Topology\ + \ aggregation. \r\n The FC represents a Cross-Connection\ + \ in an NE. The Cross-Connection in an NE is not necessarily the lowest\ + \ level of FC partitioning." items: $ref: "#/definitions/tapi.connectivity.ConnectionRef" switch-control: @@ -15047,6 +12692,9 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.connectivity.Route" + bounding-node: + description: "none" + $ref: "#/definitions/tapi.topology.NodeRef" layer-protocol-name: description: "none" $ref: "#/definitions/tapi.common.LayerProtocolName" @@ -15060,9 +12708,8 @@ definitions: $ref: "#/definitions/tapi.common.ForwardingDirection" description: "The ForwardingConstruct (FC) object class models enabled potential\ \ for forwarding between two or more LTPs and like the LTP supports any transport\ - \ protocol including all circuit and packet forms.\r\n At the\ - \ lowest level of recursion, a FC represents a cross-connection within an\ - \ NE." + \ protocol including all circuit and packet forms.\r\n At the lowest\ + \ level of recursion, a FC represents a cross-connection within an NE." tapi.connectivity.ConnectionEndPoint: allOf: - $ref: "#/definitions/tapi.common.GlobalClass" @@ -15070,6 +12717,9 @@ definitions: - $ref: "#/definitions/tapi.common.TerminationPac" - type: "object" properties: + protection-role: + description: "none" + $ref: "#/definitions/tapi.connectivity.ProtectionRole" client-node-edge-point: type: "array" description: "none" @@ -15099,7 +12749,7 @@ definitions: $ref: "#/definitions/tapi.common.PortDirection" description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ \ termination and adaptation functions of one or more transport layers. \r\ - \n The structure of LTP supports all transport protocols including\ + \n The structure of LTP supports all transport protocols including\ \ circuit and packet forms." tapi.connectivity.ConnectionEndPointRef: allOf: @@ -15109,7 +12759,7 @@ definitions: connection-end-point-uuid: type: "string" description: "none" - x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:owned-node-edge-point/tapi-connectivity:cep-list/tapi-connectivity:connection-end-point/tapi-connectivity:uuid" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:node-edge-point/tapi-connectivity:cep-list/tapi-connectivity:connection-end-point/tapi-connectivity:uuid" description: "none" tapi.connectivity.ConnectionRef: type: "object" @@ -15121,15 +12771,9 @@ definitions: tapi.connectivity.ConnectivityConstraint: type: "object" properties: - service-layer: - description: "none" - $ref: "#/definitions/tapi.common.LayerProtocolName" schedule: description: "none" $ref: "#/definitions/tapi.common.TimeRange" - connectivity-direction: - description: "none" - $ref: "#/definitions/tapi.common.ForwardingDirection" requested-capacity: description: "none" $ref: "#/definitions/tapi.common.Capacity" @@ -15142,7 +12786,7 @@ definitions: type: "string" description: "An abstract value the meaning of which is mutually agreed \ \ typically represents metrics such as - Class of service, priority, resiliency,\ - \ availability" + \ availability\r\n Class of Service Name." service-type: description: "none" $ref: "#/definitions/tapi.connectivity.ServiceType" @@ -15166,27 +12810,42 @@ definitions: allOf: - $ref: "#/definitions/tapi.common.AdminStatePac" - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" - - $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" - - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - type: "object" properties: + topology-constraint: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" end-point: type: "array" description: "none" items: $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" + resilience-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" connection: type: "array" description: "none" items: $ref: "#/definitions/tapi.connectivity.ConnectionRef" + connectivity-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + direction: + description: "none" + $ref: "#/definitions/tapi.common.ForwardingDirection" description: "The ForwardingConstruct (FC) object class models enabled potential\ \ for forwarding between two or more LTPs and like the LTP supports any transport\ - \ protocol including all circuit and packet forms.\r\n At the\ - \ lowest level of recursion, a FC represents a cross-connection within an\ - \ NE." + \ protocol including all circuit and packet forms.\r\n At the lowest\ + \ level of recursion, a FC represents a cross-connection within an NE." tapi.connectivity.ConnectivityServiceEndPoint: allOf: - $ref: "#/definitions/tapi.common.AdminStatePac" @@ -15205,6 +12864,9 @@ definitions: service-interface-point: description: "none" $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + peer-fwd-connectivity-service-end-point: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" layer-protocol-name: description: "none" $ref: "#/definitions/tapi.common.LayerProtocolName" @@ -15216,23 +12878,29 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.connectivity.ConnectionEndPointRef" + server-connectivity-service-end-point: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" direction: description: "The orientation of defined flow at the EndPoint." $ref: "#/definitions/tapi.common.PortDirection" capacity: description: "none" $ref: "#/definitions/tapi.common.Capacity" + protecting-connectivity-service-end-point: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" description: "The association of the FC to LTPs is made via EndPoints.\r\n \ - \ The EndPoint (EP) object class models the access to the FC\ - \ function. \r\n The traffic forwarding between the associated\ - \ EPs of the FC depends upon the type of FC and may be associated with FcSwitch\ - \ object instances. \r\n In cases where there is resilience\ - \ the EndPoint may convey the resilience role of the access to the FC. \r\n\ - \ It can represent a protected (resilient/reliable) point or\ - \ a protecting (unreliable working or protection) point.\r\n \ - \ The EP replaces the Protection Unit of a traditional protection model.\ - \ \r\n The ForwadingConstruct can be considered as a component\ - \ and the EndPoint as a Port on that component" + \ The EndPoint (EP) object class models the access to the FC function.\ + \ \r\n The traffic forwarding between the associated EPs of the\ + \ FC depends upon the type of FC and may be associated with FcSwitch object\ + \ instances. \r\n In cases where there is resilience the EndPoint\ + \ may convey the resilience role of the access to the FC. \r\n \ + \ It can represent a protected (resilient/reliable) point or a protecting\ + \ (unreliable working or protection) point.\r\n The EP replaces\ + \ the Protection Unit of a traditional protection model. \r\n The\ + \ ForwadingConstruct can be considered as a component and the EndPoint as\ + \ a Port on that component" tapi.connectivity.ConnectivityServiceEndPointRef: allOf: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" @@ -15290,12 +12958,12 @@ definitions: properties: output: $ref: "#/definitions/tapi.connectivity.getconnectivityservicelist.Output" - tapi.connectivity.OwnedNodeEdgePointAugmentation1: + tapi.connectivity.NodeEdgePointAugmentation1: type: "object" properties: cep-list: description: "none" - $ref: "#/definitions/tapi.connectivity.context.topologycontext.topology.node.ownednodeedgepoint.CepList" + $ref: "#/definitions/tapi.connectivity.context.topologycontext.topology.node.nodeedgepoint.CepList" x-augmentation: prefix: "tapi-connectivity" namespace: "urn:onf:otcc:yang:tapi-connectivity" @@ -15314,40 +12982,26 @@ definitions: is-lock-out: type: "boolean" description: "The resource is configured to temporarily not be available for\ - \ use in the protection scheme(s) it is part of.\r\n \ - \ This overrides all other protection control states including forced.\r\ - \n If the item is locked out then it cannot be used under\ - \ any circumstances.\r\n Note: Only relevant when part\ - \ of a protection scheme." + \ use in the protection scheme(s) it is part of.\r\n This\ + \ overrides all other protection control states including forced.\r\n \ + \ If the item is locked out then it cannot be used under any\ + \ circumstances.\r\n Note: Only relevant when part of a protection\ + \ scheme." default: false max-switch-times: type: "integer" format: "int32" description: "Used to limit the maximum swtich times. When work fault disappears\ \ , and traffic return to the original work path, switch counter reset." - restoration-coordinate-type: - description: " The coordination mechanism between multi-layers." - $ref: "#/definitions/tapi.connectivity.CoordinateType" - is-coordinated-switching-both-ends: - type: "boolean" - description: "Is operating such that switching at both ends of each flow acorss\ - \ the FC is coordinated at both ingress and egress ends." - default: false + protection-type: + description: "none" + $ref: "#/definitions/tapi.topology.ProtectionType" hold-off-time: type: "integer" format: "int32" description: "This attribute indicates the time, in milliseconds, between\ \ declaration of signal degrade or signal fail, and the initialization of\ \ the protection switching algorithm." - is-frozen: - type: "boolean" - description: "Temporarily prevents any switch action to be taken and, as such,\ - \ freezes the current state. \r\n Until the freeze is\ - \ cleared, additional near-end external commands are rejected and fault\ - \ condition changes and received APS messages are ignored.\r\n \ - \ All administrative controls of any aspect of protection are\ - \ rejected." - default: false wait-to-revert-time: type: "integer" format: "int32" @@ -15355,9 +13009,9 @@ definitions: \ the time, in minutes, to wait after a fault clears on a higher priority\ \ (preferred) resource before reverting to the preferred resource." default: 15 - resilience-type: - description: "none" - $ref: "#/definitions/tapi.topology.ResilienceType" + selection-control: + description: "Degree of administrative control applied to the switch selection." + $ref: "#/definitions/tapi.connectivity.SelectionControl" preferred-restoration-layer: type: "array" description: "Indicate which layer this resilience parameters package configured\ @@ -15368,6 +13022,28 @@ definitions: type: "integer" format: "int32" description: "none" + restoration-policy: + description: "none" + $ref: "#/definitions/tapi.topology.RestorationPolicy" + restoration-coordinate-type: + description: " The coordination mechanism between multi-layers." + $ref: "#/definitions/tapi.connectivity.CoordinateType" + is-coordinated-switching-both-ends: + type: "boolean" + description: "Is operating such that switching at both ends of each flow acorss\ + \ the FC is coordinated at both ingress and egress ends." + default: false + fault-condition-determination: + type: "string" + description: "none" + is-frozen: + type: "boolean" + description: "Temporarily prevents any switch action to be taken and, as such,\ + \ freezes the current state. \r\n Until the freeze is cleared,\ + \ additional near-end external commands are rejected and fault condition\ + \ changes and received APS messages are ignored.\r\n All\ + \ administrative controls of any aspect of protection are rejected." + default: false reversion-mode: description: "Indcates whether the protection scheme is revertive or non-revertive." $ref: "#/definitions/tapi.connectivity.ReversionMode" @@ -15387,9 +13063,9 @@ definitions: items: $ref: "#/definitions/tapi.connectivity.ConnectionEndPointRef" description: "The FC Route (FcRoute) object class models the individual routes\ - \ of an FC. \r\n The route of an FC object is represented by\ - \ a list of FCs at a lower level. \r\n Note that depending\ - \ on the service supported by an FC, an the FC can have multiple routes." + \ of an FC. \r\n The route of an FC object is represented by a\ + \ list of FCs at a lower level. \r\n Note that depending on the\ + \ service supported by an FC, an the FC can have multiple routes." tapi.connectivity.RouteRef: allOf: - $ref: "#/definitions/tapi.connectivity.ConnectionRef" @@ -15439,9 +13115,6 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.connectivity.RouteRef" - selection-control: - description: "Degree of administrative control applied to the switch selection." - $ref: "#/definitions/tapi.connectivity.SelectionControl" selection-reason: description: "The reason for the current switch selection." $ref: "#/definitions/tapi.connectivity.SelectionReason" @@ -15451,32 +13124,31 @@ definitions: $ref: "#/definitions/tapi.common.PortDirection" description: "The class models the switched forwarding of traffic (traffic flow)\ \ between FcPorts (ConnectionEndPoints) and is present where there is protection\ - \ functionality in the FC (Connection). \r\n If an FC exposes\ - \ protection (having two or more FcPorts that provide alternative identical\ - \ inputs/outputs), the FC will have one or more associated FcSwitch objects\ - \ to represent the alternative flow choices visible at the edge of the FC.\r\ - \n The FC switch represents and defines a protection switch\ - \ structure encapsulated in the FC. \r\n Essentially performs\ - \ one of the functions of the Protection Group in a traditional model. It\ - \ associates to 2 or more FcPorts each playing the role of a Protection Unit.\ - \ \r\n One or more protection, i.e. standby/backup, FcPorts\ - \ provide protection for one or more working (i.e. regular/main/preferred)\ - \ FcPorts where either protection or working can feed one or more protected\ - \ FcPort.\r\n The switch may be used in revertive or non-revertive\ - \ (symmetric) mode. When in revertive mode it may define a waitToRestore time.\r\ - \n It may be used in one of several modes including source\ - \ switch, destination switched, source and destination switched etc (covering\ - \ cases such as 1+1 and 1:1).\r\n It may be locked out (prevented\ - \ from switching), force switched or manual switched.\r\n It\ - \ will indicate switch state and change of state.\r\n The switch\ - \ can be switched away from all sources such that it becomes open and hence\ - \ two coordinated switches can both feed the same LTP so long as at least\ - \ one of the two is switched away from all sources (is 'open').\r\n \ - \ The ability for a Switch to be 'high impedance' allows bidirectional\ - \ ForwardingConstructs to be overlaid on the same bidirectional LTP where\ - \ the appropriate control is enabled to prevent signal conflict.\r\n \ - \ This ability allows multiple alternate routes to be present that\ - \ otherwise would be in conflict." + \ functionality in the FC (Connection). \r\n If an FC exposes protection\ + \ (having two or more FcPorts that provide alternative identical inputs/outputs),\ + \ the FC will have one or more associated FcSwitch objects to represent the\ + \ alternative flow choices visible at the edge of the FC.\r\n The\ + \ FC switch represents and defines a protection switch structure encapsulated\ + \ in the FC. \r\n Essentially performs one of the functions of\ + \ the Protection Group in a traditional model. It associates to 2 or more\ + \ FcPorts each playing the role of a Protection Unit. \r\n One\ + \ or more protection, i.e. standby/backup, FcPorts provide protection for\ + \ one or more working (i.e. regular/main/preferred) FcPorts where either protection\ + \ or working can feed one or more protected FcPort.\r\n The switch\ + \ may be used in revertive or non-revertive (symmetric) mode. When in revertive\ + \ mode it may define a waitToRestore time.\r\n It may be used in\ + \ one of several modes including source switch, destination switched, source\ + \ and destination switched etc (covering cases such as 1+1 and 1:1).\r\n \ + \ It may be locked out (prevented from switching), force switched\ + \ or manual switched.\r\n It will indicate switch state and change\ + \ of state.\r\n The switch can be switched away from all sources\ + \ such that it becomes open and hence two coordinated switches can both feed\ + \ the same LTP so long as at least one of the two is switched away from all\ + \ sources (is 'open').\r\n The ability for a Switch to be 'high\ + \ impedance' allows bidirectional ForwardingConstructs to be overlaid on the\ + \ same bidirectional LTP where the appropriate control is enabled to prevent\ + \ signal conflict.\r\n This ability allows multiple alternate routes\ + \ to be present that otherwise would be in conflict." tapi.connectivity.SwitchControl: allOf: - $ref: "#/definitions/tapi.common.GlobalClass" @@ -15515,7 +13187,7 @@ definitions: allOf: - $ref: "#/definitions/tapi.connectivity.ConnectionEndPoint" - $ref: "#/definitions/tapi.oam.ConnectionEndPointAugmentation1" - tapi.connectivity.context.topologycontext.topology.node.ownednodeedgepoint.CepList: + tapi.connectivity.context.topologycontext.topology.node.nodeedgepoint.CepList: allOf: - type: "object" properties: @@ -15529,8 +13201,10 @@ definitions: type: "object" properties: topology-constraint: + type: "array" description: "none" - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" end-point: type: "array" description: "none" @@ -15539,15 +13213,35 @@ definitions: resilience-constraint: description: "none" $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" routing-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.RoutingConstraint" state: - type: "string" description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" connectivity-constraint: description: "none" $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.connectivity.createconnectivityservice.Output: type: "object" properties: @@ -15557,15 +13251,29 @@ definitions: tapi.connectivity.deleteconnectivityservice.Input: type: "object" properties: - service-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.connectivity.getconnectiondetails.Input: type: "object" properties: - connection-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.connectivity.getconnectiondetails.Output: type: "object" properties: @@ -15575,18 +13283,16 @@ definitions: tapi.connectivity.getconnectionendpointdetails.Input: type: "object" properties: - cep-id-or-name: - type: "string" - description: "none" - nep-id-or-name: - type: "string" - description: "none" - node-id-or-name: - type: "string" - description: "none" - topology-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.connectivity.getconnectionendpointdetails.Output: type: "object" properties: @@ -15596,9 +13302,16 @@ definitions: tapi.connectivity.getconnectivityservicedetails.Input: type: "object" properties: - service-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.connectivity.getconnectivityservicedetails.Output: type: "object" properties: @@ -15616,12 +13329,11 @@ definitions: tapi.connectivity.updateconnectivityservice.Input: type: "object" properties: - service-id-or-name: - type: "string" - description: "none" topology-constraint: + type: "array" description: "none" - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" end-point: type: "array" description: "none" @@ -15630,43 +13342,44 @@ definitions: resilience-constraint: description: "none" $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" routing-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.RoutingConstraint" state: - type: "string" description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" connectivity-constraint: description: "none" $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.connectivity.updateconnectivityservice.Output: type: "object" properties: service: description: "none" $ref: "#/definitions/tapi.connectivity.ConnectivityService" - tapi.notification.AlarmInfo: - type: "object" - properties: - perceived-severity: - description: "none" - $ref: "#/definitions/tapi.notification.PerceivedSeverityType" - probable-cause: - type: "string" - description: "none" - service-affecting: - description: "none" - $ref: "#/definitions/tapi.notification.ServiceAffecting" - is-transient: - type: "boolean" - description: "none" - default: false tapi.notification.ContextAugmentation2: type: "object" properties: notification-context: description: "Augments the base TAPI Context with NotificationService information" - $ref: "#/definitions/tapi.notification.NotificationContext" + $ref: "#/definitions/tapi.notification.context.NotificationContext" x-augmentation: prefix: "tapi-notification" namespace: "urn:onf:otcc:yang:tapi-notification" @@ -15675,11 +13388,6 @@ definitions: properties: output: $ref: "#/definitions/tapi.notification.createnotificationsubscriptionservice.Output" - tapi.notification.DeleteNotificationSubscriptionService: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.notification.deletenotificationsubscriptionservice.Output" tapi.notification.GetNotificationList: type: "object" properties: @@ -15718,8 +13426,8 @@ definitions: - type: "object" properties: target-object-type: + type: "string" description: "none" - $ref: "#/definitions/tapi.notification.ObjectType" additional-text: type: "string" description: "none" @@ -15735,18 +13443,15 @@ definitions: type: "integer" format: "int32" description: "A monotonous increasing sequence number associated with the\ - \ notification.\r\n The exact semantics of how this\ - \ sequence number is assigned (per channel or subscription or source or\ - \ system) is left undefined." - tca-info: - description: "none" - $ref: "#/definitions/tapi.notification.TcaInfo" + \ notification.\r\n The exact semantics of how this sequence\ + \ number is assigned (per channel or subscription or source or system)\ + \ is left undefined." target-object-identifier: type: "string" description: "none" notification-type: + type: "string" description: "none" - $ref: "#/definitions/tapi.notification.NotificationType" target-object-name: type: "array" description: "none" @@ -15758,9 +13463,9 @@ definitions: source-indicator: description: "none" $ref: "#/definitions/tapi.notification.SourceIndicator" - alarm-info: + layer-protocol-qualifier: + type: "string" description: "none" - $ref: "#/definitions/tapi.notification.AlarmInfo" changed-attributes: type: "array" description: "none" @@ -15780,23 +13485,10 @@ definitions: stream-address: type: "string" description: "The address/location/URI of the channel/stream to which the\ - \ subscribed notifications are published.\r\n This\ - \ specifics of this is typically dependent on the implementation protocol\ - \ & mechanism and hence is typed as a string." + \ subscribed notifications are published.\r\n This specifics\ + \ of this is typically dependent on the implementation protocol & mechanism\ + \ and hence is typed as a string." description: "none" - tapi.notification.NotificationContext: - type: "object" - properties: - notif-subscription: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - notification: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.Notification" tapi.notification.NotificationSubscriptionService: allOf: - $ref: "#/definitions/tapi.common.GlobalClass" @@ -15817,68 +13509,16 @@ definitions: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.ObjectType" + type: "string" supported-notification-types: type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.NotificationType" - subscription-filter: - description: "none" - $ref: "#/definitions/tapi.notification.SubscriptionFilter" - description: "none" - tapi.notification.NotificationType: - type: "string" - enum: - - "OBJECT_CREATION" - - "OBJECT_DELETION" - - "ATTRIBUTE_VALUE_CHANGE" - - "ALARM_EVENT" - - "THRESHOLD_CROSSING_ALERT" - tapi.notification.ObjectType: - type: "string" - enum: - - "TOPOLOGY" - - "NODE" - - "LINK" - - "CONNECTION" - - "PATH" - - "CONNECTIVITY_SERVICE" - - "VIRTUAL_NETWORK_SERVICE" - - "PATH_COMPUTATION_SERVICE" - - "NODE_EDGE_POINT" - - "SERVICE_INTERFACE_POINT" - - "CONNECTION_END_POINT" - - "MAINTENANCE_ENTITY_GROUP" - - "MAINTENANCE_ENTITY" - - "MEG_END_POINT" - - "MEG_INTERMEDIATE_POINT" - - "SWITCH_CONTROL" - - "SWITCH" - - "ROUTE" - - "NODE_RULE_GROUP" - - "INTER_RULE_GROUP" - - "RULE" - - "OAM_JOB" - tapi.notification.PerceivedSeverityType: - type: "string" - enum: - - "CRITICAL" - - "MAJOR" - - "MINOR" - - "WARNING" - - "CLEARED" - tapi.notification.PerceivedTcaSeverity: - type: "string" - enum: - - "WARNING" - - "CLEAR" - tapi.notification.ServiceAffecting: - type: "string" - enum: - - "SERVICE_AFFECTING" - - "NOT_SERVICE_AFFECTING" - - "UNKNOWN" + description: "none" + items: + type: "string" + subscription-filter: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + description: "none" tapi.notification.SourceIndicator: type: "string" enum: @@ -15894,7 +13534,7 @@ definitions: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.NotificationType" + type: "string" requested-object-identifier: type: "array" description: "none" @@ -15915,57 +13555,56 @@ definitions: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.ObjectType" + type: "string" description: "none" tapi.notification.SubscriptionState: type: "string" enum: - "SUSPENDED" - "ACTIVE" - tapi.notification.TcaInfo: - type: "object" - properties: - threshold-crossing: - description: "none" - $ref: "#/definitions/tapi.notification.ThresholdCrossingType" - threshold-parameter: - type: "string" - description: "none" - is-transient: - type: "boolean" - description: "none" - default: false - threshold-value: - type: "integer" - format: "int32" - description: "none" - perceived-severity: - description: "none" - $ref: "#/definitions/tapi.notification.PerceivedTcaSeverity" - suspect-interval-flag: - type: "boolean" - description: "none" - default: false - measurement-interval: - type: "string" - description: "none" - tapi.notification.ThresholdCrossingType: - type: "string" - enum: - - "THRESHOLD_ABOVE" - - "THRESHOLD_BELOW" - - "CLEARED" tapi.notification.UpdateNotificationSubscriptionService: type: "object" properties: output: $ref: "#/definitions/tapi.notification.updatenotificationsubscriptionservice.Output" + tapi.notification.context.NotificationContext: + allOf: + - type: "object" + properties: + notif-subscription: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + notification: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.notificationcontext.Notification" + description: "Augments the base TAPI Context with NotificationService information" tapi.notification.createnotificationsubscriptionservice.Input: type: "object" properties: subscription-state: description: "none" $ref: "#/definitions/tapi.notification.SubscriptionState" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" subscription-filter: description: "none" $ref: "#/definitions/tapi.notification.SubscriptionFilter" @@ -15978,24 +13617,33 @@ definitions: tapi.notification.deletenotificationsubscriptionservice.Input: type: "object" properties: - subscription-id-or-name: + uuid: type: "string" - description: "none" - tapi.notification.deletenotificationsubscriptionservice.Output: - type: "object" - properties: - subscription-service: - description: "none" - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.notification.getnotificationlist.Input: type: "object" properties: - time-period: - type: "string" - description: "none" - subscription-id-or-name: - type: "string" + time-range: description: "none" + $ref: "#/definitions/tapi.common.TimeRange" + subscription-id: + type: "string" + description: "UUID of the associated Notification Subscription Service: An\ + \ identifier that is universally unique within an identifier space, where\ + \ the identifier space is itself globally unique, and immutable.\r\n \ + \ An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.notification.getnotificationlist.Output: type: "object" properties: @@ -16003,13 +13651,20 @@ definitions: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.Notification" + $ref: "#/definitions/tapi.notification.notificationcontext.Notification" tapi.notification.getnotificationsubscriptionservicedetails.Input: type: "object" properties: - subscription-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.notification.getnotificationsubscriptionservicedetails.Output: type: "object" properties: @@ -16031,30 +13686,65 @@ definitions: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.ObjectType" + type: "string" supported-notification-types: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.NotificationType" + type: "string" + tapi.notification.notificationcontext.Notification: + allOf: + - $ref: "#/definitions/tapi.notification.Notification" + - $ref: "#/definitions/tapi.oam.NotificationAugmentation1" + - $ref: "#/definitions/tapi.oam.NotificationAugmentation2" tapi.notification.updatenotificationsubscriptionservice.Input: type: "object" properties: subscription-state: description: "none" $ref: "#/definitions/tapi.notification.SubscriptionState" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" subscription-filter: description: "none" $ref: "#/definitions/tapi.notification.SubscriptionFilter" - subscription-id-or-name: - type: "string" - description: "none" tapi.notification.updatenotificationsubscriptionservice.Output: type: "object" properties: subscription-service: description: "none" $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + tapi.oam.AlarmInfo: + type: "object" + properties: + perceived-severity: + description: "none" + $ref: "#/definitions/tapi.oam.PerceivedSeverityType" + probable-cause: + type: "string" + description: "none" + service-affecting: + description: "none" + $ref: "#/definitions/tapi.oam.ServiceAffecting" + is-transient: + type: "boolean" + description: "none" + default: false tapi.oam.ConnectionEndPointAugmentation1: type: "object" properties: @@ -16064,7 +13754,7 @@ definitions: x-augmentation: prefix: "tapi-oam" namespace: "urn:onf:otcc:yang:tapi-oam" - tapi.oam.ContextAugmentation1: + tapi.oam.ContextAugmentation3: type: "object" properties: oam-context: @@ -16078,16 +13768,47 @@ definitions: properties: output: $ref: "#/definitions/tapi.oam.createoamjob.Output" + tapi.oam.CreateOamProfile: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.createoamprofile.Output" tapi.oam.CreateOamService: type: "object" properties: output: $ref: "#/definitions/tapi.oam.createoamservice.Output" - tapi.oam.CreateOamServiceEndPoint: + tapi.oam.CreateOamServicePoint: type: "object" properties: output: - $ref: "#/definitions/tapi.oam.createoamserviceendpoint.Output" + $ref: "#/definitions/tapi.oam.createoamservicepoint.Output" + tapi.oam.CurrentData: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + elapsed-time: + description: "none" + $ref: "#/definitions/tapi.common.TimeInterval" + period-start-time: + type: "string" + description: "This attribute indicates the start of the current monitoring\ + \ interval.\r\n The value is bound to the quarter of an\ + \ hour in case of a 15 minute interval and bound to the hour in case of\ + \ a 24 hour interval." + pm-data-pac: + description: "none" + $ref: "#/definitions/tapi.oam.PmDataPac" + history-data: + type: "array" + description: "in case of 24hr Current Data, at least 1 History Data.\r\n\ + \ In case of 15min Current Data, at least 16 History Data.\r\ + \n In case of <15min, the number of History Data shall\ + \ be able to cover a span of 4 hours." + items: + $ref: "#/definitions/tapi.oam.HistoryData" + description: "none" tapi.oam.GetMeg: type: "object" properties: @@ -16098,53 +13819,75 @@ definitions: properties: output: $ref: "#/definitions/tapi.oam.getoamjob.Output" - tapi.oam.GetOamService: + tapi.oam.GetOamJobList: type: "object" properties: output: - $ref: "#/definitions/tapi.oam.getoamservice.Output" - tapi.oam.GetOamServiceEndPoint: + $ref: "#/definitions/tapi.oam.getoamjoblist.Output" + tapi.oam.GetOamProfile: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getoamprofile.Output" + tapi.oam.GetOamProfileList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getoamprofilelist.Output" + tapi.oam.GetOamService: type: "object" properties: output: - $ref: "#/definitions/tapi.oam.getoamserviceendpoint.Output" + $ref: "#/definitions/tapi.oam.getoamservice.Output" tapi.oam.GetOamServiceList: type: "object" properties: output: $ref: "#/definitions/tapi.oam.getoamservicelist.Output" - tapi.oam.Meg: + tapi.oam.GetOamServicePoint: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getoamservicepoint.Output" + tapi.oam.HistoryData: allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.common.OperationalStatePac" + - $ref: "#/definitions/tapi.common.LocalClass" - type: "object" properties: - meg-identifier: + period-start-time: type: "string" + description: "This attribute indicates the start of the monitoring interval.\r\ + \n The value is bound to the quarter of an hour in case\ + \ of a 15 minute interval and bound to the hour in case of a 24 hour interval." + pm-data-pac: description: "none" - meg-level: - type: "integer" - format: "int32" + $ref: "#/definitions/tapi.oam.PmDataPac" + period-end-time: + type: "string" description: "none" - mip: - type: "array" - description: "ME may 0, 1, or more MIPs" - items: - $ref: "#/definitions/tapi.oam.Mip" + description: "none" + tapi.oam.Meg: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.common.OperationalStatePac" + - type: "object" + properties: layer-protocol-name: description: "none" $ref: "#/definitions/tapi.common.LayerProtocolName" mep: type: "array" description: "1. ME may have 0 MEPs (case of transit domains where at least\ - \ 1 MIP is present)\r\n 2. ME may have 1 MEP (case\ - \ of edge domaind, where the peer MEP is ouside the managed domain)\r\n\ - \ 3. ME may have 2 MEPs" + \ 1 MIP is present)\r\n 2. ME may have 1 MEP (case of edge\ + \ domaind, where the peer MEP is ouside the managed domain)\r\n \ + \ 3. ME may have 2 MEPs" items: $ref: "#/definitions/tapi.oam.Mep" - direction: - description: "none" - $ref: "#/definitions/tapi.common.ForwardingDirection" + mip: + type: "array" + description: "ME may 0, 1, or more MIPs" + items: + $ref: "#/definitions/tapi.oam.Mip" description: "none" tapi.oam.MegRef: type: "object" @@ -16162,17 +13905,6 @@ definitions: layer-protocol-name: description: "none" $ref: "#/definitions/tapi.common.LayerProtocolName" - peer-mep-identifier: - type: "array" - description: "none" - items: - type: "string" - mep-identifier: - type: "string" - description: "none" - direction: - description: "none" - $ref: "#/definitions/tapi.common.TerminationDirection" description: "none" tapi.oam.MepMipList: type: "object" @@ -16216,19 +13948,24 @@ definitions: description: "none" x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:meg/tapi-oam:mip/tapi-oam:local-id" description: "none" - tapi.oam.OamConstraint: + tapi.oam.NotificationAugmentation1: type: "object" properties: - layer-protocol-name: - description: "none" - $ref: "#/definitions/tapi.common.LayerProtocolName" - meg-level: - type: "integer" - format: "int32" + alarm-info: description: "none" - direction: + $ref: "#/definitions/tapi.oam.AlarmInfo" + x-augmentation: + prefix: "tapi-oam" + namespace: "urn:onf:otcc:yang:tapi-oam" + tapi.oam.NotificationAugmentation2: + type: "object" + properties: + tca-info: description: "none" - $ref: "#/definitions/tapi.common.ForwardingDirection" + $ref: "#/definitions/tapi.oam.TcaInfo" + x-augmentation: + prefix: "tapi-oam" + namespace: "urn:onf:otcc:yang:tapi-oam" tapi.oam.OamContext: type: "object" properties: @@ -16264,27 +14001,34 @@ definitions: oam-profile: description: "none" $ref: "#/definitions/tapi.oam.OamProfileRef" - pm-current-data: - type: "array" - description: "Granularity period of the CurrentData identifies the specific\ - \ CurrentData instance in the scope of this OamJob.\r\n \ - \ For example, typically at least\r\n one 15min\ - \ and\r\n one 24hr;\r\n optionally\ - \ one additional configurable (< 15min)" - items: - $ref: "#/definitions/tapi.oam.PmCurrentData" creation-time: type: "string" description: "none" - oam-service-end-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamServiceEndPointRef" oam-job-type: type: "string" description: "none" + oam-service-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamServicePointRef" + current-data: + type: "array" + description: "Granularity period of the CurrentData identifies the specific\ + \ CurrentData instance in the scope of this OamJob.\r\n \ + \ For example, typically at least\r\n one 15min and\r\n\ + \ one 24hr;\r\n optionally one additional\ + \ configurable (< 15min)" + items: + $ref: "#/definitions/tapi.oam.CurrentData" description: "none" + tapi.oam.OamJobRef: + type: "object" + properties: + oam-job-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-job/tapi-oam:uuid" tapi.oam.OamProfile: allOf: - $ref: "#/definitions/tapi.common.GlobalClass" @@ -16295,11 +14039,6 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.oam.PmThresholdData" - pm-bin-data: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.PmBinData" description: "none" tapi.oam.OamProfileRef: type: "object" @@ -16312,37 +14051,26 @@ definitions: allOf: - $ref: "#/definitions/tapi.common.AdminStatePac" - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.oam.OamConstraint" - type: "object" properties: - oam-profile: + layer-protocol-name: description: "none" - $ref: "#/definitions/tapi.oam.OamProfileRef" - end-point: + $ref: "#/definitions/tapi.common.LayerProtocolName" + oam-service-point: type: "array" description: "none" items: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" + $ref: "#/definitions/tapi.oam.OamServicePoint" meg: description: "none" $ref: "#/definitions/tapi.oam.MegRef" description: "none" - tapi.oam.OamServiceEndPoint: + tapi.oam.OamServicePoint: allOf: - $ref: "#/definitions/tapi.common.AdminStatePac" - $ref: "#/definitions/tapi.common.LocalClass" - type: "object" properties: - peer-mep-identifier: - type: "array" - description: "This attribute models the MI_PeerMEP_ID[i] defined in G.8021\ - \ and configured as specified in G.8051. It provides the identifiers of\ - \ the MEPs which are peer to the subject MEP.\r\n This\ - \ attribute is not specified in case the OSEP relates to the provisioing\ - \ of an MIP.\r\n In case of P2P, there is only one\ - \ peer" - items: - type: "string" connectivity-service-end-point: description: "none" $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" @@ -16352,30 +14080,27 @@ definitions: service-interface-point: description: "none" $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + is-mip: + type: "boolean" + description: "If true, the object is related to a MIP.\r\n \ + \ If false, the object is related to a MEP." + default: false layer-protocol-name: description: "none" $ref: "#/definitions/tapi.common.LayerProtocolName" mep: description: "none" $ref: "#/definitions/tapi.oam.MepRef" - mep-identifier: - type: "string" - description: "This attribute contains the identifier of the MEP.\r\n \ - \ This attribute is empty in case the OSEP relates to\ - \ the provisioing of an MIP.\r\n " - direction: - description: "none" - $ref: "#/definitions/tapi.common.PortDirection" description: "none" - tapi.oam.OamServiceEndPointRef: + tapi.oam.OamServicePointRef: allOf: - $ref: "#/definitions/tapi.oam.OamServiceRef" - type: "object" properties: - oam-service-end-point-local-id: + oam-service-point-local-id: type: "string" description: "none" - x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-service/tapi-oam:end-point/tapi-oam:local-id" + x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-service/tapi-oam:oam-service-point/tapi-oam:local-id" description: "none" tapi.oam.OamServiceRef: type: "object" @@ -16384,55 +14109,49 @@ definitions: type: "string" description: "none" x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-service/tapi-oam:uuid" - tapi.oam.PmBinData: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - granularity-period: - description: "none" - $ref: "#/definitions/tapi.common.TimePeriod" - description: "none" - tapi.oam.PmCurrentData: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - elapsed-time: - description: "none" - $ref: "#/definitions/tapi.common.TimeInterval" - pm-history-data: - type: "array" - description: "in case of 24hr Current Data, at least 1 History Data.\r\n\ - \ In case of 15min Current Data, at least 16 History\ - \ Data.\r\n In case of <15min, the number of History\ - \ Data shall be able to cover a span of 4 hours." - items: - $ref: "#/definitions/tapi.oam.PmHistoryData" - granularity-period: - description: "none" - $ref: "#/definitions/tapi.common.TimePeriod" - suspect-interval-flag: - type: "boolean" - description: "This attribute is used to indicate that the performance data\ - \ for the current period may not be reliable. Some reasons for this to\ - \ occur are:\r\n Suspect data were detected by the\ - \ actual resource doing data collection.\r\n Transition\ - \ of the administrativeState attribute to/from the 'lock' state.\r\n \ - \ Transition of the operationalState to/from the 'disabled'\ - \ state.\r\n Scheduler setting that inhibits the\ - \ collection function.\r\n The performance counters\ - \ were reset during the interval.\r\n The currentData\ - \ (or subclass) object instance was created during the monitoring period." - default: false - timestamp: - type: "string" - description: "This attribute indicates the start of the current monitoring\ - \ interval.\r\n The value is bound to the quarter of\ - \ an hour in case of a 15 minute interval and bound to the hour in case\ - \ of a 24 hour interval." - description: "none" - tapi.oam.PmHistoryData: + tapi.oam.PerceivedSeverityType: + type: "string" + enum: + - "CRITICAL" + - "MAJOR" + - "MINOR" + - "WARNING" + - "CLEARED" + tapi.oam.PerceivedTcaSeverity: + type: "string" + enum: + - "WARNING" + - "CLEAR" + tapi.oam.PmDataPac: + type: "object" + properties: + suspect-interval-flag: + type: "boolean" + description: "This attribute is used to indicate that the performance data\ + \ for the current period may not be reliable. Some reasons for this to occur\ + \ are:\r\n Suspect data were detected by the actual resource\ + \ doing data collection.\r\n Transition of the administrativeState\ + \ attribute to/from the 'lock' state.\r\n Transition of\ + \ the operationalState to/from the 'disabled' state.\r\n \ + \ Scheduler setting that inhibits the collection function.\r\n \ + \ The performance counters were reset during the interval.\r\n\ + \ The currentData (or subclass) object instance was created\ + \ during the monitoring period." + default: false + granularity-period: + description: "none" + $ref: "#/definitions/tapi.common.TimePeriod" + tapi.oam.PmParameterValue: + type: "object" + properties: + pm-parameter-int-value: + type: "integer" + format: "int32" + description: "none" + pm-parameter-real-value: + type: "string" + description: "none" + tapi.oam.PmThresholdData: allOf: - $ref: "#/definitions/tapi.common.LocalClass" - type: "object" @@ -16440,151 +14159,368 @@ definitions: granularity-period: description: "none" $ref: "#/definitions/tapi.common.TimePeriod" - period-end-time: - type: "string" + threshold-parameter: + type: "array" description: "none" - suspect-interval-flag: - type: "boolean" - description: "This attribute indicates that the performance data may not\ - \ be reliable." - default: false - description: "none" - tapi.oam.PmThresholdData: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: + items: + $ref: "#/definitions/tapi.oam.ThresholdParameter" is-transient: type: "boolean" description: "none" default: false - granularity-period: - description: "none" - $ref: "#/definitions/tapi.common.TimePeriod" + applicable-job-type: + type: "array" + description: "This attribute allows an PMThresholdData instance to be constrained\ + \ to specific job types. If an PMThresholdData instance is so configured\ + \ to be applicable to more than one job type (worst case ALL), only the\ + \ parameters relevant for the job instance will be used (non-applicable\ + \ profile parameters will be ignored)" + items: + type: "string" description: "none" + tapi.oam.ServiceAffecting: + type: "string" + enum: + - "SERVICE_AFFECTING" + - "NOT_SERVICE_AFFECTING" + - "UNKNOWN" + tapi.oam.TcaInfo: + type: "object" + properties: + oam-job: + description: "MEF 35.1\r\n Identification of the PM Session\ + \ for which the TCA Function was configured." + $ref: "#/definitions/tapi.oam.OamJobRef" + threshold-parameter: + description: "none" + $ref: "#/definitions/tapi.oam.ThresholdParameter" + is-transient: + type: "boolean" + description: "none" + default: false + perceived-severity: + description: "none" + $ref: "#/definitions/tapi.oam.PerceivedTcaSeverity" + suspect-interval-flag: + type: "boolean" + description: "none" + default: false + measurement-interval: + type: "string" + description: "none" + tapi.oam.ThresholdCrossingQualifier: + type: "string" + enum: + - "NOT_APPLICABLE" + - "NEAR_END" + - "FAR_END" + - "BIDIRECTIONAL" + - "FORWARD" + - "BACKWARD" + tapi.oam.ThresholdParameter: + type: "object" + properties: + pm-parameter-below-thrs: + description: "none" + $ref: "#/definitions/tapi.oam.PmParameterValue" + pm-parameter-clear-thrs: + description: "none" + $ref: "#/definitions/tapi.oam.PmParameterValue" + pm-parameter-above-thrs: + description: "none" + $ref: "#/definitions/tapi.oam.PmParameterValue" + pm-parameter-name: + type: "string" + description: "none" + threshold-location: + description: "none" + $ref: "#/definitions/tapi.oam.ThresholdCrossingQualifier" tapi.oam.UpdateOamJob: type: "object" properties: output: $ref: "#/definitions/tapi.oam.updateoamjob.Output" + tapi.oam.UpdateOamProfile: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.updateoamprofile.Output" tapi.oam.UpdateOamService: type: "object" properties: output: $ref: "#/definitions/tapi.oam.updateoamservice.Output" - tapi.oam.UpdateOamServiceEndPoint: + tapi.oam.UpdateOamServicePoint: type: "object" properties: output: - $ref: "#/definitions/tapi.oam.updateoamserviceendpoint.Output" + $ref: "#/definitions/tapi.oam.updateoamservicepoint.Output" tapi.oam.createoamjob.Input: type: "object" properties: schedule: - type: "string" description: "none" - oam-service-end-point: + $ref: "#/definitions/tapi.common.TimeRange" + name: type: "array" - description: "none" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." items: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" + $ref: "#/definitions/tapi.common.NameAndValue" + oam-service-point-id: + type: "string" + description: "UUID of the associated OSEPs: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" oam-job-type: type: "string" description: "none" - oam-profile: - description: "none" - $ref: "#/definitions/tapi.oam.OamProfile" state: - type: "string" description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + oam-profile-id: + type: "string" + description: "UUID of the OamProfile to be applied: An identifier that is\ + \ universally unique within an identifier space, where the identifier space\ + \ is itself globally unique, and immutable.\r\n An UUID\ + \ carries no semantics with respect to the purpose or state of the entity.\r\ + \n UUID here uses string representation as defined in\ + \ RFC 4122. The canonical representation uses lowercase characters.\r\n\ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + oam-service-id: + type: "string" + description: "UUID of the associated OamService: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.oam.createoamjob.Output: type: "object" properties: oam-job: description: "none" $ref: "#/definitions/tapi.oam.OamJob" - tapi.oam.createoamservice.Input: + tapi.oam.createoamprofile.Input: type: "object" properties: - oam-constraint: - description: "none" - $ref: "#/definitions/tapi.oam.OamConstraint" - state: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: type: "string" - description: "none" - end-point: + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + pm-threshold-data: type: "array" description: "none" items: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - tapi.oam.createoamservice.Output: + $ref: "#/definitions/tapi.oam.PmThresholdData" + tapi.oam.createoamprofile.Output: type: "object" properties: - service: + oam-profile: description: "none" - $ref: "#/definitions/tapi.oam.OamService" - tapi.oam.createoamserviceendpoint.Input: + $ref: "#/definitions/tapi.oam.OamProfile" + tapi.oam.createoamservice.Input: type: "object" properties: - peer-mep-identifier: - type: "array" + layer-protocol-name: description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." items: - type: "string" - service-id: - type: "string" + $ref: "#/definitions/tapi.common.NameAndValue" + oam-service-point: + type: "array" description: "none" - sip-id: - type: "string" + items: + $ref: "#/definitions/tapi.oam.OamServicePoint" + state: description: "none" - c-sep-id: + $ref: "#/definitions/tapi.common.AdministrativeState" + uuid: type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.createoamservice.Output: + type: "object" + properties: + oam-service: description: "none" - mep-identifier: - type: "string" + $ref: "#/definitions/tapi.oam.OamService" + tapi.oam.createoamservicepoint.Input: + type: "object" + properties: + layer-protocol-name: description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" state: - type: "string" - description: "none" - layer: - type: "string" description: "none" - direction: + $ref: "#/definitions/tapi.common.AdministrativeState" + connectivity-service-end-point-id: + type: "string" + description: "UUID of the CSEP to be monitored: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + service-interface-point-id: + type: "string" + description: "UUID of the associated SIP to be monitored: An identifier that\ + \ is universally unique within an identifier space, where the identifier\ + \ space is itself globally unique, and immutable.\r\n \ + \ An UUID carries no semantics with respect to the purpose or state of\ + \ the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + oam-service-id: + type: "string" + description: "UUID of the parent OamService: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + uuid: type: "string" - description: "none" - tapi.oam.createoamserviceendpoint.Output: + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.createoamservicepoint.Output: type: "object" properties: - end-point: + oam-service-point: description: "none" - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" + $ref: "#/definitions/tapi.oam.OamServicePoint" tapi.oam.deleteoamjob.Input: type: "object" properties: - job-id: + uuid: type: "string" - description: "none" - tapi.oam.deleteoamservice.Input: + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.deleteoamprofile.Input: type: "object" properties: - service-id: + uuid: type: "string" - description: "none" - tapi.oam.deleteoamserviceendpoint.Input: + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.deleteoamservice.Input: type: "object" properties: - service-id: + uuid: type: "string" - description: "none" - o-sep-id: + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.deleteoamservicepoint.Input: + type: "object" + properties: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.oam.getmeg.Input: type: "object" properties: - service-id: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.oam.getmeg.Output: type: "object" properties: @@ -16594,118 +14530,246 @@ definitions: tapi.oam.getoamjob.Input: type: "object" properties: - job-id: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.oam.getoamjob.Output: type: "object" properties: oam-job: description: "none" $ref: "#/definitions/tapi.oam.OamJob" - tapi.oam.getoamservice.Input: + tapi.oam.getoamjoblist.Output: type: "object" properties: - service-id: - type: "string" + oam-job: + type: "array" description: "none" - tapi.oam.getoamservice.Output: + items: + $ref: "#/definitions/tapi.oam.OamJob" + tapi.oam.getoamprofile.Input: type: "object" properties: - service: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.getoamprofile.Output: + type: "object" + properties: + oam-profile: description: "none" - $ref: "#/definitions/tapi.oam.OamService" - tapi.oam.getoamserviceendpoint.Input: + $ref: "#/definitions/tapi.oam.OamProfile" + tapi.oam.getoamprofilelist.Output: type: "object" properties: - service-id: - type: "string" + oam-profile: + type: "array" description: "none" - o-sep-id: + items: + $ref: "#/definitions/tapi.oam.OamProfile" + tapi.oam.getoamservice.Input: + type: "object" + properties: + uuid: type: "string" - description: "none" - tapi.oam.getoamserviceendpoint.Output: + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.getoamservice.Output: type: "object" properties: - end-point: + oam-service: description: "none" - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" + $ref: "#/definitions/tapi.oam.OamService" tapi.oam.getoamservicelist.Output: type: "object" properties: - service: + oam-service: type: "array" description: "none" - items: - $ref: "#/definitions/tapi.oam.OamService" + items: + $ref: "#/definitions/tapi.oam.OamService" + tapi.oam.getoamservicepoint.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.getoamservicepoint.Output: + type: "object" + properties: + oam-service-point: + description: "none" + $ref: "#/definitions/tapi.oam.OamServicePoint" tapi.oam.updateoamjob.Input: type: "object" properties: - job-id: - type: "string" - description: "none" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" schedule: - type: "string" - description: "none" - oam-profile: description: "none" - $ref: "#/definitions/tapi.oam.OamProfile" + $ref: "#/definitions/tapi.common.TimeRange" state: - type: "string" description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + oam-profile-id: + type: "string" + description: "UUID of the OamProfile to be applied: An identifier that is\ + \ universally unique within an identifier space, where the identifier space\ + \ is itself globally unique, and immutable.\r\n An UUID\ + \ carries no semantics with respect to the purpose or state of the entity.\r\ + \n UUID here uses string representation as defined in\ + \ RFC 4122. The canonical representation uses lowercase characters.\r\n\ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.oam.updateoamjob.Output: type: "object" properties: oam-job: description: "none" $ref: "#/definitions/tapi.oam.OamJob" - tapi.oam.updateoamservice.Input: + tapi.oam.updateoamprofile.Input: type: "object" properties: - oam-constraint: - description: "none" - $ref: "#/definitions/tapi.oam.OamConstraint" - service-id: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + pm-threshold-data: + type: "array" description: "none" - state: - type: "string" + items: + $ref: "#/definitions/tapi.oam.PmThresholdData" + tapi.oam.updateoamprofile.Output: + type: "object" + properties: + oam-profile: description: "none" - end-point: + $ref: "#/definitions/tapi.oam.OamProfile" + tapi.oam.updateoamservice.Input: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + oam-service-point: type: "array" description: "none" items: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" + $ref: "#/definitions/tapi.oam.OamServicePoint" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.oam.updateoamservice.Output: type: "object" properties: - service: + oam-service: description: "none" $ref: "#/definitions/tapi.oam.OamService" - tapi.oam.updateoamserviceendpoint.Input: + tapi.oam.updateoamservicepoint.Input: type: "object" properties: - service-id: - type: "string" - description: "none" - o-sep-id: - type: "string" - description: "none" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" state: - type: "string" description: "none" - tapi.oam.updateoamserviceendpoint.Output: + $ref: "#/definitions/tapi.common.AdministrativeState" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.updateoamservicepoint.Output: type: "object" properties: - end-point: + oam-service-point: description: "none" - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" + $ref: "#/definitions/tapi.oam.OamServicePoint" tapi.path.computation.ComputeP2PPath: type: "object" properties: output: $ref: "#/definitions/tapi.path.computation.computep2ppath.Output" - tapi.path.computation.ContextAugmentation3: + tapi.path.computation.ContextAugmentation1: type: "object" properties: path-computation-context: @@ -16774,8 +14838,10 @@ definitions: - type: "object" properties: topology-constraint: + type: "array" description: "none" - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" path: type: "array" description: "none" @@ -16789,12 +14855,18 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" routing-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.RoutingConstraint" optimization-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" + direction: + description: "none" + $ref: "#/definitions/tapi.common.ForwardingDirection" description: "none" tapi.path.computation.PathObjectiveFunction: allOf: @@ -16859,16 +14931,16 @@ definitions: description: "none" $ref: "#/definitions/tapi.common.Capacity" description: "The association of the FC to LTPs is made via EndPoints.\r\n \ - \ The EndPoint (EP) object class models the access to the FC\ - \ function. \r\n The traffic forwarding between the associated\ - \ EPs of the FC depends upon the type of FC and may be associated with FcSwitch\ - \ object instances. \r\n In cases where there is resilience\ - \ the EndPoint may convey the resilience role of the access to the FC. \r\n\ - \ It can represent a protected (resilient/reliable) point or\ - \ a protecting (unreliable working or protection) point.\r\n \ - \ The EP replaces the Protection Unit of a traditional protection model.\ - \ \r\n The ForwadingConstruct can be considered as a component\ - \ and the EndPoint as a Port on that component" + \ The EndPoint (EP) object class models the access to the FC function.\ + \ \r\n The traffic forwarding between the associated EPs of the\ + \ FC depends upon the type of FC and may be associated with FcSwitch object\ + \ instances. \r\n In cases where there is resilience the EndPoint\ + \ may convey the resilience role of the access to the FC. \r\n \ + \ It can represent a protected (resilient/reliable) point or a protecting\ + \ (unreliable working or protection) point.\r\n The EP replaces\ + \ the Protection Unit of a traditional protection model. \r\n The\ + \ ForwadingConstruct can be considered as a component and the EndPoint as\ + \ a Port on that component" tapi.path.computation.RouteObjectiveFunction: type: "string" enum: @@ -16886,6 +14958,9 @@ definitions: type: "boolean" description: "To distinguish if the resources are to be exclusive to the service" default: true + tolerable-impact: + type: "string" + description: "Grades of maximum tolerable disruption to traffic." diversity-policy: description: "none" $ref: "#/definitions/tapi.path.computation.DiversityPolicy" @@ -16909,78 +14984,100 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.topology.RiskCharacteristic" - route-direction: - description: "none" - $ref: "#/definitions/tapi.common.ForwardingDirection" tapi.path.computation.TopologyConstraint: - type: "object" - properties: - include-node: - type: "array" - description: "This is a loose constraint - that is it is unordered and could\ - \ be a partial list" - items: - $ref: "#/definitions/tapi.topology.NodeRef" - exclude-link: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.LinkRef" - avoid-topology: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.TopologyRef" - exclude-path: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.path.computation.PathRef" - include-link: - type: "array" - description: "This is a loose constraint - that is it is unordered and could\ - \ be a partial list " - items: - $ref: "#/definitions/tapi.topology.LinkRef" - preferred-transport-layer: - type: "array" - description: "soft constraint requested by client to indicate the layer(s)\ - \ of transport connection that it prefers to carry the service. This could\ - \ be same as the service layer or one of the supported server layers" - items: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + include-node: + type: "string" + description: "This is a loose constraint - that is it is unordered and could\ + \ be a partial list" + exclude-link: + type: "string" + description: "none" + avoid-topology: + type: "string" + description: "none" + exclude-path: + type: "string" + description: "none" + include-topology: + type: "string" + description: "none" + include-path: + type: "string" + description: "none" + exclude-node-edge-point: + type: "string" + description: "none" + include-node-edge-point: + type: "string" + description: "none" + include-link: + type: "string" + description: "This is a loose constraint - that is it is unordered and could\ + \ be a partial list " + preferred-transport-layer: + description: "soft constraint requested by client to indicate the layer(s)\ + \ of transport connection that it prefers to carry the service. This could\ + \ be same as the service layer or one of the supported server layers" $ref: "#/definitions/tapi.common.LayerProtocolName" - exclude-node: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.NodeRef" - include-topology: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.TopologyRef" - include-path: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.path.computation.PathRef" + exclude-node: + type: "string" + description: "none" + constraint-weight: + type: "integer" + format: "int32" + description: "Zero and positive values: zero means 'strongly required to\ + \ be included', +1 means 'less strongly required to be included', etc.\r\ + \n For example the work/intended route will be calculated\ + \ considering the topologies which weights are lowest (but not negative).\r\ + \n Negative values: -1 means 'strongly required to be excluded',\ + \ -2 means 'less strongly required to be excluded', etc." + description: "The TopologyConstraint allows to specify topology entities in\ + \ order to impose specific constraints (as denoted by the attribute name)\ + \ on Connectivity/Path.\r\n The topology entities are specified\ + \ by their instance uuid rather than using references/path (to allow for mapping\ + \ to Yang 1.0).\r\n This loose typing and reference necessitates\ + \ that implementations validate not only the presence of the instance, but\ + \ also that it is of the correct type as implied by the attribute name.\r\n\ + \ If this validation fails, then the implementation is expceted\ + \ to return an error.\r\n " tapi.path.computation.computep2ppath.Input: type: "object" properties: topology-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - routing-constraint: + end-point: + type: "array" description: "none" - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + items: + $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" objective-function: description: "none" $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" - sep: + name: type: "array" - description: "none" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." items: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + $ref: "#/definitions/tapi.common.NameAndValue" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.path.computation.computep2ppath.Output: type: "object" properties: @@ -16990,9 +15087,16 @@ definitions: tapi.path.computation.deletep2ppath.Input: type: "object" properties: - path-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.path.computation.deletep2ppath.Output: type: "object" properties: @@ -17002,15 +15106,29 @@ definitions: tapi.path.computation.optimizep2ppath.Input: type: "object" properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" routing-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - path-id-or-name: - type: "string" - description: "none" optimization-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" objective-function: description: "none" $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" @@ -17106,7 +15224,7 @@ definitions: type: "string" description: "High frequency deviation from true periodicity of a signal and\ \ therefore a small high rate of change of transfer latency.\r\n \ - \ Applies to TDM systems (and not packet)." + \ Applies to TDM systems (and not packet)." fixed-latency-characteristic: type: "string" description: "A TopologicalEntity suffers delay caused by the realization\ @@ -17117,7 +15235,7 @@ definitions: type: "string" description: "Low frequency deviation from true periodicity of a signal and\ \ therefore a small low rate of change of transfer latency.\r\n \ - \ Applies to TDM systems (and not packet)." + \ Applies to TDM systems (and not packet)." queing-latency-characteristic: type: "string" description: "The specific queuing latency for the traffic property." @@ -17149,19 +15267,22 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.common.LayerProtocolName" - resilience-type: + restoration-policy: description: "none" - $ref: "#/definitions/tapi.topology.ResilienceType" + $ref: "#/definitions/tapi.topology.RestorationPolicy" node-edge-point: type: "array" description: "none" items: $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + protection-type: + description: "none" + $ref: "#/definitions/tapi.topology.ProtectionType" direction: - description: "The directionality of the Link. \r\n Is\ - \ applicable to simple Links where all LinkEnds are BIDIRECTIONAL (the\ - \ Link will be BIDIRECTIONAL) or UNIDIRECTIONAL (the Link will be UNIDIRECTIONAL).\ - \ \r\n Is not present in more complex cases." + description: "The directionality of the Link. \r\n Is applicable\ + \ to simple Links where all LinkEnds are BIDIRECTIONAL (the Link will\ + \ be BIDIRECTIONAL) or UNIDIRECTIONAL (the Link will be UNIDIRECTIONAL).\ + \ \r\n Is not present in more complex cases." $ref: "#/definitions/tapi.common.ForwardingDirection" description: "The Link object class models effective adjacency between two or\ \ more ForwardingDomains (FD). " @@ -17175,6 +15296,16 @@ definitions: description: "none" x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:link/tapi-topology:uuid" description: "none" + tapi.topology.NepLayerProtocolCapability: + type: "object" + properties: + layer-protocol-qualifier: + type: "string" + description: "none" + number-of-cep-instances: + type: "integer" + format: "int32" + description: "none" tapi.topology.NetworkTopologyService: allOf: - $ref: "#/definitions/tapi.common.GlobalClass" @@ -17204,16 +15335,16 @@ definitions: encap-topology: description: "none" $ref: "#/definitions/tapi.topology.TopologyRef" - owned-node-edge-point: + node-rule-group: type: "array" description: "none" items: - $ref: "#/definitions/tapi.topology.NodeEdgePoint" - node-rule-group: + $ref: "#/definitions/tapi.topology.NodeRuleGroup" + node-edge-point: type: "array" description: "none" items: - $ref: "#/definitions/tapi.topology.NodeRuleGroup" + $ref: "#/definitions/tapi.topology.NodeEdgePoint" aggregated-node-edge-point: type: "array" description: "none" @@ -17222,8 +15353,8 @@ definitions: description: "The ForwardingDomain (FD) object class models the ForwardingDomain\ \ topological component which is used to effect forwarding of transport characteristic\ \ information and offers the potential to enable forwarding. \r\n \ - \ At the lowest level of recursion, an FD (within a network element\ - \ (NE)) represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ + \ At the lowest level of recursion, an FD (within a network element (NE))\ + \ represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ \ multiple switch matrices (FDs). " tapi.topology.NodeEdgePoint: allOf: @@ -17245,6 +15376,11 @@ definitions: \ balancing/Resilience) should be considered experimental" items: $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + available-cep-layer-protocol: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NepLayerProtocolCapability" aggregated-node-edge-point: type: "array" description: "none" @@ -17256,14 +15392,9 @@ definitions: link-port-direction: description: "The orientation of defined flow at the LinkEnd." $ref: "#/definitions/tapi.common.PortDirection" - supported-cep-layer-protocol-qualifier: - type: "array" - description: "none" - items: - type: "string" description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ \ termination and adaptation functions of one or more transport layers. \r\ - \n The structure of LTP supports all transport protocols including\ + \n The structure of LTP supports all transport protocols including\ \ circuit and packet forms." tapi.topology.NodeEdgePointRef: allOf: @@ -17273,7 +15404,7 @@ definitions: node-edge-point-uuid: type: "string" description: "none" - x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:owned-node-edge-point/tapi-topology:uuid" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:node-edge-point/tapi-topology:uuid" description: "none" tapi.topology.NodeRef: allOf: @@ -17328,41 +15459,32 @@ definitions: tapi.topology.ProtectionType: type: "string" enum: - - "NO_PROTECTON" + - "NO_PROTECTION" - "ONE_PLUS_ONE_PROTECTION" - - "ONE_PLUS_ONE_PROTECTION_WITH_DYNAMIC_RESTORATION" - - "PERMANENT_ONE_PLUS_ONE_PROTECTION" - "ONE_FOR_ONE_PROTECTION" - - "DYNAMIC_RESTORATION" - - "PRE_COMPUTED_RESTORATION" - tapi.topology.ResilienceType: - type: "object" - properties: - restoration-policy: - description: "none" - $ref: "#/definitions/tapi.topology.RestorationPolicy" - protection-type: - description: "none" - $ref: "#/definitions/tapi.topology.ProtectionType" + - "ONE_FOR_N_PROTECTION" + - "M_FOR_N_PROTECTION" + - "ONE_FOR_ONE_BY_N" tapi.topology.RestorationPolicy: type: "string" enum: - "PER_DOMAIN_RESTORATION" - "END_TO_END_RESTORATION" - "NA" + - "DYNAMIC_RESTORATION" + - "PRE_COMPUTED_RESTORATION" tapi.topology.RiskCharacteristic: type: "object" properties: risk-characteristic-name: type: "string" description: "The name of the risk characteristic. The characteristic may\ - \ be related to a specific degree of closeness. \r\n \ - \ For example a particular characteristic may apply to failures that are\ - \ localized (e.g. to one side of a road) where as another characteristic\ - \ may relate to failures that have a broader impact (e.g. both sides of\ - \ a road that crosses a bridge).\r\n Depending upon the\ - \ importance of the traffic being routed different risk characteristics\ - \ will be evaluated." + \ be related to a specific degree of closeness. \r\n For\ + \ example a particular characteristic may apply to failures that are localized\ + \ (e.g. to one side of a road) where as another characteristic may relate\ + \ to failures that have a broader impact (e.g. both sides of a road that\ + \ crosses a bridge).\r\n Depending upon the importance of\ + \ the traffic being routed different risk characteristics will be evaluated." risk-identifier-list: type: "array" description: "A list of the identifiers of each physical/geographic unit (with\ @@ -17424,11 +15546,16 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.topology.Node" + boundary-node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" description: "The ForwardingDomain (FD) object class models the ForwardingDomain\ \ topological component which is used to effect forwarding of transport characteristic\ \ information and offers the potential to enable forwarding. \r\n \ - \ At the lowest level of recursion, an FD (within a network element\ - \ (NE)) represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ + \ At the lowest level of recursion, an FD (within a network element (NE))\ + \ represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ \ multiple switch matrices (FDs). " tapi.topology.TopologyContext: type: "object" @@ -17463,7 +15590,7 @@ definitions: error-characteristic: type: "string" description: "Describes the degree to which the signal propagated can be errored.\ - \ \r\n Applies to TDM systems as the errored signal will\ + \ \r\n Applies to TDM systems as the errored signal will\ \ be propagated and not packet as errored packets will be discarded." unavailable-time-characteristic: type: "string" @@ -17476,19 +15603,19 @@ definitions: delivery-order-characteristic: type: "string" description: "Describes the degree to which packets will be delivered out\ - \ of sequence.\r\n Does not apply to TDM as the TDM protocols\ + \ of sequence.\r\n Does not apply to TDM as the TDM protocols\ \ maintain strict order." repeat-delivery-characteristic: type: "string" description: "Primarily applies to packet systems where a packet may be delivered\ - \ more than once (in fault recovery for example). \r\n \ - \ It can also apply to TDM where several frames may be received twice\ - \ due to switching in a system with a large differential propagation delay." + \ more than once (in fault recovery for example). \r\n It\ + \ can also apply to TDM where several frames may be received twice due to\ + \ switching in a system with a large differential propagation delay." loss-characteristic: type: "string" description: "Describes the acceptable characteristic of lost packets where\ \ loss may result from discard due to errors or overflow.\r\n \ - \ Applies to packet systems and not TDM (as for TDM errored signals\ + \ Applies to packet systems and not TDM (as for TDM errored signals\ \ are propagated unless grossly errored and overflow/underflow turns into\ \ timing slips)." tapi.topology.TransferTimingPac: @@ -17525,12 +15652,27 @@ definitions: tapi.topology.getlinkdetails.Input: type: "object" properties: - link-id-or-name: + link-id: type: "string" - description: "none" - topology-id-or-name: - type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.topology.getlinkdetails.Output: type: "object" properties: @@ -17540,12 +15682,27 @@ definitions: tapi.topology.getnodedetails.Input: type: "object" properties: - node-id-or-name: - type: "string" - description: "none" - topology-id-or-name: - type: "string" - description: "none" + node-id: + type: "string" + description: "UUID of the Node: An identifier that is universally unique within\ + \ an identifier space, where the identifier space is itself globally unique,\ + \ and immutable.\r\n An UUID carries no semantics with\ + \ respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC 4122. The canonical\ + \ representation uses lowercase characters.\r\n Pattern:\ + \ [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\ + \ \r\n Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.topology.getnodedetails.Output: type: "object" properties: @@ -17555,15 +15712,37 @@ definitions: tapi.topology.getnodeedgepointdetails.Input: type: "object" properties: - ep-id-or-name: - type: "string" - description: "none" - node-id-or-name: - type: "string" - description: "none" - topology-id-or-name: + node-id: + type: "string" + description: "UUID of the parent Node: An identifier that is universally unique\ + \ within an identifier space, where the identifier space is itself globally\ + \ unique, and immutable.\r\n An UUID carries no semantics\ + \ with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC 4122. The\ + \ canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\ + \ \r\n Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Node's Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + node-edge-point-id: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.topology.getnodeedgepointdetails.Output: type: "object" properties: @@ -17573,9 +15752,16 @@ definitions: tapi.topology.gettopologydetails.Input: type: "object" properties: - topology-id-or-name: + topology-id: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.topology.gettopologydetails.Output: type: "object" properties: @@ -17590,9 +15776,9 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.topology.Topology" - tapi.topology.node.OwnedNodeEdgePoint: + tapi.topology.node.NodeEdgePoint: allOf: - - $ref: "#/definitions/tapi.connectivity.OwnedNodeEdgePointAugmentation1" + - $ref: "#/definitions/tapi.connectivity.NodeEdgePointAugmentation1" - $ref: "#/definitions/tapi.topology.NodeEdgePoint" tapi.topology.topology.Node: allOf: @@ -17612,16 +15798,16 @@ definitions: encap-topology: description: "none" $ref: "#/definitions/tapi.topology.TopologyRef" - owned-node-edge-point: + node-rule-group: type: "array" description: "none" items: - $ref: "#/definitions/tapi.topology.node.OwnedNodeEdgePoint" - node-rule-group: + $ref: "#/definitions/tapi.topology.NodeRuleGroup" + node-edge-point: type: "array" description: "none" items: - $ref: "#/definitions/tapi.topology.NodeRuleGroup" + $ref: "#/definitions/tapi.topology.node.NodeEdgePoint" aggregated-node-edge-point: type: "array" description: "none" diff --git a/OAS/tapi-equipment@2019-03-31.yaml b/OAS/tapi-equipment@2019-03-31.yaml new file mode 100644 index 00000000..e9b7b9ae --- /dev/null +++ b/OAS/tapi-equipment@2019-03-31.yaml @@ -0,0 +1,6624 @@ +--- +swagger: "2.0" +info: + description: "\r\n This module contains TAPI Notification Model definitions.\r\ + \n Source: TapiNotification.uml\r\n Copyright (c) 2018 Open Networking\ + \ Foundation (ONF). All rights reserved.\r\n License: This module is distributed\ + \ under the Apache License 2.0\r\n - The TAPI YANG models included in this\ + \ TAPI release are a *normative* part of the TAPI SDK.\r\n - The YANG specifications\ + \ have been generated from the corresponding UML model using the [ONF EAGLE UML2YANG\ + \ mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Topology\ + \ Model definitions.\r\n Source: TapiTopology.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n - The TAPI YANG models included in\ + \ this TAPI release are a *normative* part of the TAPI SDK.\r\n - The YANG\ + \ specifications have been generated from the corresponding UML model using the\ + \ [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Common Model\ + \ definitions.\r\n Source: TapiCommon.uml\r\n Copyright (c) 2018\ + \ Open Networking Foundation (ONF). All rights reserved.\r\n License: This\ + \ module is distributed under the Apache License 2.0\r\n - The TAPI YANG\ + \ models included in this TAPI release are a *normative* part of the TAPI SDK.\r\ + \n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases." + version: "2.2.0" + title: "tapi-notification,tapi-topology,tapi-equipment,tapi-common API" +host: "localhost:1234" +consumes: +- "application/yang-data+json" +produces: +- "application/yang-data+json" +paths: + /data/context/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.Context" + description: "none" + parameters: [] + responses: + 200: + description: "tapi.common.Context" + schema: + $ref: "#/definitions/tapi.common.Context" + 400: + description: "Internal error" + post: + tags: + - "tapi-common" + summary: "creates tapi.common.Context" + description: "none" + parameters: + - in: "body" + name: "tapi.common.Context.body-param" + description: "tapi.common.Context to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.Context" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.Context" + description: "none" + parameters: + - in: "body" + name: "tapi.common.Context.body-param" + description: "tapi.common.Context to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.Context" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-common" + summary: "removes tapi.common.Context" + description: "none" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/name/: + post: + tags: + - "tapi-common" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/name={value-name}/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-common" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: [] + responses: + 200: + description: "tapi.notification.NotificationContext" + schema: + $ref: "#/definitions/tapi.notification.NotificationContext" + 400: + description: "Internal error" + post: + tags: + - "tapi-notification" + summary: "creates tapi.notification.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: + - in: "body" + name: "tapi.notification.NotificationContext.body-param" + description: "tapi.notification.NotificationContext to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.notification.NotificationContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.notification.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: + - in: "body" + name: "tapi.notification.NotificationContext.body-param" + description: "tapi.notification.NotificationContext to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.notification.NotificationContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.notification.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notif-subscription/: + post: + tags: + - "tapi-notification" + summary: "creates tapi.notification.NotificationSubscriptionService" + description: "none" + parameters: + - in: "body" + name: "tapi.notification.NotificationSubscriptionService.body-param" + description: "tapi.notification.NotificationSubscriptionService to be added\ + \ to list" + required: false + schema: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/notification-context/notif-subscription={uuid}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NotificationSubscriptionService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.NotificationSubscriptionService" + schema: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + 400: + description: "Internal error" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.notification.NotificationSubscriptionService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.notification.NotificationSubscriptionService.body-param" + description: "tapi.notification.NotificationSubscriptionService to be added\ + \ or updated" + required: false + schema: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.notification.NotificationSubscriptionService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notif-subscription={uuid}/name/: + post: + tags: + - "tapi-notification" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/notification-context/notif-subscription={uuid}/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notif-subscription={uuid}/notification-channel/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NotificationChannel" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.NotificationChannel" + schema: + $ref: "#/definitions/tapi.notification.NotificationChannel" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification-channel/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.Notification" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.Notification" + schema: + $ref: "#/definitions/tapi.notification.Notification" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/additional-info={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of additional-info" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/changed-attributes={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NameAndValueChange" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of changed-attributes" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.NameAndValueChange" + schema: + $ref: "#/definitions/tapi.notification.NameAndValueChange" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/target-object-name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of target-object-name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.SubscriptionFilter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.SubscriptionFilter" + schema: + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + 400: + description: "Internal error" + post: + tags: + - "tapi-notification" + summary: "creates tapi.notification.SubscriptionFilter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.notification.SubscriptionFilter.body-param" + description: "tapi.notification.SubscriptionFilter to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.notification.SubscriptionFilter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.notification.SubscriptionFilter.body-param" + description: "tapi.notification.SubscriptionFilter to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.notification.SubscriptionFilter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name/: + post: + tags: + - "tapi-notification" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notification={uuid}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.Notification" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.Notification" + schema: + $ref: "#/definitions/tapi.notification.Notification" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/additional-info={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of additional-info" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/changed-attributes={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NameAndValueChange" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of changed-attributes" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.NameAndValueChange" + schema: + $ref: "#/definitions/tapi.notification.NameAndValueChange" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/target-object-name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of target-object-name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/physical-context/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.PhysicalContext" + description: "none" + parameters: [] + responses: + 200: + description: "tapi.equipment.PhysicalContext" + schema: + $ref: "#/definitions/tapi.equipment.PhysicalContext" + 400: + description: "Internal error" + post: + tags: + - "tapi-equipment" + summary: "creates tapi.equipment.PhysicalContext" + description: "none" + parameters: + - in: "body" + name: "tapi.equipment.PhysicalContext.body-param" + description: "tapi.equipment.PhysicalContext to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.equipment.PhysicalContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-equipment" + summary: "creates or updates tapi.equipment.PhysicalContext" + description: "none" + parameters: + - in: "body" + name: "tapi.equipment.PhysicalContext.body-param" + description: "tapi.equipment.PhysicalContext to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.equipment.PhysicalContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-equipment" + summary: "removes tapi.equipment.PhysicalContext" + description: "none" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/physical-context/device={uuid}/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.Device" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of device" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.Device" + schema: + $ref: "#/definitions/tapi.equipment.Device" + 400: + description: "Internal error" + /data/context/physical-context/device={uuid}/access-port={access-port-uuid}/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.AccessPort" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of device" + required: true + type: "string" + - name: "access-port-uuid" + in: "path" + description: "Id of access-port" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.AccessPort" + schema: + $ref: "#/definitions/tapi.equipment.AccessPort" + 400: + description: "Internal error" + ? /data/context/physical-context/device={uuid}/access-port={access-port-uuid}/connector-pin={connector-identification},{pin-identification},{equipment-uuid}/ + : get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.ConnectorPinAddress" + description: "The list of Pins that support the AccessPort." + parameters: + - name: "uuid" + in: "path" + description: "Id of device" + required: true + type: "string" + - name: "access-port-uuid" + in: "path" + description: "Id of access-port" + required: true + type: "string" + - name: "connector-identification" + in: "path" + description: "Id of connector-pin" + required: true + type: "string" + - name: "pin-identification" + in: "path" + description: "Id of connector-pin" + required: true + type: "string" + - name: "equipment-uuid" + in: "path" + description: "Id of connector-pin" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.ConnectorPinAddress" + schema: + $ref: "#/definitions/tapi.equipment.ConnectorPinAddress" + 400: + description: "Internal error" + /data/context/physical-context/device={uuid}/access-port={access-port-uuid}/name={value-name}/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of device" + required: true + type: "string" + - name: "access-port-uuid" + in: "path" + description: "Id of access-port" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/physical-context/device={uuid}/equipment={equipment-uuid}/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.Equipment" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of device" + required: true + type: "string" + - name: "equipment-uuid" + in: "path" + description: "Id of equipment" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.Equipment" + schema: + $ref: "#/definitions/tapi.equipment.Equipment" + 400: + description: "Internal error" + /data/context/physical-context/device={uuid}/equipment={equipment-uuid}/actual-equipment/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.ActualEquipment" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of device" + required: true + type: "string" + - name: "equipment-uuid" + in: "path" + description: "Id of equipment" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.ActualEquipment" + schema: + $ref: "#/definitions/tapi.equipment.ActualEquipment" + 400: + description: "Internal error" + /data/context/physical-context/device={uuid}/equipment={equipment-uuid}/actual-equipment/actual-non-field-replaceable-module/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.ActualNonFieldReplaceableModule" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of device" + required: true + type: "string" + - name: "equipment-uuid" + in: "path" + description: "Id of equipment" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.ActualNonFieldReplaceableModule" + schema: + $ref: "#/definitions/tapi.equipment.ActualNonFieldReplaceableModule" + 400: + description: "Internal error" + ? /data/context/physical-context/device={uuid}/equipment={equipment-uuid}/actual-equipment/actual-non-field-replaceable-module/common-actual-properties/ + : get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.CommonActualProperties" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of device" + required: true + type: "string" + - name: "equipment-uuid" + in: "path" + description: "Id of equipment" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.CommonActualProperties" + schema: + $ref: "#/definitions/tapi.equipment.CommonActualProperties" + 400: + description: "Internal error" + ? /data/context/physical-context/device={uuid}/equipment={equipment-uuid}/actual-equipment/actual-non-field-replaceable-module/common-equipment-properties/ + : get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.CommonEquipmentProperties" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of device" + required: true + type: "string" + - name: "equipment-uuid" + in: "path" + description: "Id of equipment" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.CommonEquipmentProperties" + schema: + $ref: "#/definitions/tapi.equipment.CommonEquipmentProperties" + 400: + description: "Internal error" + /data/context/physical-context/device={uuid}/equipment={equipment-uuid}/actual-equipment/common-actual-properties/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.CommonActualProperties" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of device" + required: true + type: "string" + - name: "equipment-uuid" + in: "path" + description: "Id of equipment" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.CommonActualProperties" + schema: + $ref: "#/definitions/tapi.equipment.CommonActualProperties" + 400: + description: "Internal error" + /data/context/physical-context/device={uuid}/equipment={equipment-uuid}/actual-equipment/common-equipment-properties/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.CommonEquipmentProperties" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of device" + required: true + type: "string" + - name: "equipment-uuid" + in: "path" + description: "Id of equipment" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.CommonEquipmentProperties" + schema: + $ref: "#/definitions/tapi.equipment.CommonEquipmentProperties" + 400: + description: "Internal error" + /data/context/physical-context/device={uuid}/equipment={equipment-uuid}/contained-holder={contained-holder-uuid}/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.Holder" + description: "References the Holder in an Equipment that is available to take\ + \ other Equipments.\r\n For example:\r\n - Slot\ + \ in a sub-rack\r\n - Slot in a Field Replaceable Unit that\ + \ can take a small form-factor pluggable." + parameters: + - name: "uuid" + in: "path" + description: "Id of device" + required: true + type: "string" + - name: "equipment-uuid" + in: "path" + description: "Id of equipment" + required: true + type: "string" + - name: "contained-holder-uuid" + in: "path" + description: "Id of contained-holder" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.Holder" + schema: + $ref: "#/definitions/tapi.equipment.Holder" + 400: + description: "Internal error" + /data/context/physical-context/device={uuid}/equipment={equipment-uuid}/contained-holder={contained-holder-uuid}/actual-holder/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.ActualHolder" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of device" + required: true + type: "string" + - name: "equipment-uuid" + in: "path" + description: "Id of equipment" + required: true + type: "string" + - name: "contained-holder-uuid" + in: "path" + description: "Id of contained-holder" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.ActualHolder" + schema: + $ref: "#/definitions/tapi.equipment.ActualHolder" + 400: + description: "Internal error" + ? /data/context/physical-context/device={uuid}/equipment={equipment-uuid}/contained-holder={contained-holder-uuid}/actual-holder/common-holder-properties/ + : get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.CommonHolderProperties" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of device" + required: true + type: "string" + - name: "equipment-uuid" + in: "path" + description: "Id of equipment" + required: true + type: "string" + - name: "contained-holder-uuid" + in: "path" + description: "Id of contained-holder" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.CommonHolderProperties" + schema: + $ref: "#/definitions/tapi.equipment.CommonHolderProperties" + 400: + description: "Internal error" + ? /data/context/physical-context/device={uuid}/equipment={equipment-uuid}/contained-holder={contained-holder-uuid}/expected-holder/ + : get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.ExpectedHolder" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of device" + required: true + type: "string" + - name: "equipment-uuid" + in: "path" + description: "Id of equipment" + required: true + type: "string" + - name: "contained-holder-uuid" + in: "path" + description: "Id of contained-holder" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.ExpectedHolder" + schema: + $ref: "#/definitions/tapi.equipment.ExpectedHolder" + 400: + description: "Internal error" + ? /data/context/physical-context/device={uuid}/equipment={equipment-uuid}/contained-holder={contained-holder-uuid}/expected-holder/common-holder-properties/ + : get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.CommonHolderProperties" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of device" + required: true + type: "string" + - name: "equipment-uuid" + in: "path" + description: "Id of equipment" + required: true + type: "string" + - name: "contained-holder-uuid" + in: "path" + description: "Id of contained-holder" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.CommonHolderProperties" + schema: + $ref: "#/definitions/tapi.equipment.CommonHolderProperties" + 400: + description: "Internal error" + ? /data/context/physical-context/device={uuid}/equipment={equipment-uuid}/contained-holder={contained-holder-uuid}/name={value-name}/ + : get: + tags: + - "tapi-equipment" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of device" + required: true + type: "string" + - name: "equipment-uuid" + in: "path" + description: "Id of equipment" + required: true + type: "string" + - name: "contained-holder-uuid" + in: "path" + description: "Id of contained-holder" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/physical-context/device={uuid}/equipment={equipment-uuid}/contained-holder={contained-holder-uuid}/occupying-fru/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.EquipmentRef" + description: "The FRU that is occupying the holder. \r\n A holder\ + \ may be unoccupied. \r\n An FRU may occupy more hat one holder\ + \ (using or blocking are intentionally not distinguished here)." + parameters: + - name: "uuid" + in: "path" + description: "Id of device" + required: true + type: "string" + - name: "equipment-uuid" + in: "path" + description: "Id of equipment" + required: true + type: "string" + - name: "contained-holder-uuid" + in: "path" + description: "Id of contained-holder" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.EquipmentRef" + schema: + $ref: "#/definitions/tapi.equipment.EquipmentRef" + 400: + description: "Internal error" + /data/context/physical-context/device={uuid}/equipment={equipment-uuid}/expected-equipment/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.ExpectedEquipment" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of device" + required: true + type: "string" + - name: "equipment-uuid" + in: "path" + description: "Id of equipment" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.ExpectedEquipment" + schema: + $ref: "#/definitions/tapi.equipment.ExpectedEquipment" + 400: + description: "Internal error" + /data/context/physical-context/device={uuid}/equipment={equipment-uuid}/expected-equipment/common-equipment-properties/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.CommonEquipmentProperties" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of device" + required: true + type: "string" + - name: "equipment-uuid" + in: "path" + description: "Id of equipment" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.CommonEquipmentProperties" + schema: + $ref: "#/definitions/tapi.equipment.CommonEquipmentProperties" + 400: + description: "Internal error" + /data/context/physical-context/device={uuid}/equipment={equipment-uuid}/expected-equipment/expected-holder/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.ExpectedHolder" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of device" + required: true + type: "string" + - name: "equipment-uuid" + in: "path" + description: "Id of equipment" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.ExpectedHolder" + schema: + $ref: "#/definitions/tapi.equipment.ExpectedHolder" + 400: + description: "Internal error" + ? /data/context/physical-context/device={uuid}/equipment={equipment-uuid}/expected-equipment/expected-holder/common-holder-properties/ + : get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.CommonHolderProperties" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of device" + required: true + type: "string" + - name: "equipment-uuid" + in: "path" + description: "Id of equipment" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.CommonHolderProperties" + schema: + $ref: "#/definitions/tapi.equipment.CommonHolderProperties" + 400: + description: "Internal error" + ? /data/context/physical-context/device={uuid}/equipment={equipment-uuid}/expected-equipment/expected-non-field-replaceable-module/ + : get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.ExpectedNonFieldReplaceableModule" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of device" + required: true + type: "string" + - name: "equipment-uuid" + in: "path" + description: "Id of equipment" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.ExpectedNonFieldReplaceableModule" + schema: + $ref: "#/definitions/tapi.equipment.ExpectedNonFieldReplaceableModule" + 400: + description: "Internal error" + ? /data/context/physical-context/device={uuid}/equipment={equipment-uuid}/expected-equipment/expected-non-field-replaceable-module/common-equipment-properties/ + : get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.CommonEquipmentProperties" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of device" + required: true + type: "string" + - name: "equipment-uuid" + in: "path" + description: "Id of equipment" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.CommonEquipmentProperties" + schema: + $ref: "#/definitions/tapi.equipment.CommonEquipmentProperties" + 400: + description: "Internal error" + /data/context/physical-context/device={uuid}/equipment={equipment-uuid}/name={value-name}/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of device" + required: true + type: "string" + - name: "equipment-uuid" + in: "path" + description: "Id of equipment" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/physical-context/device={uuid}/name={value-name}/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of device" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/physical-context/name/: + post: + tags: + - "tapi-equipment" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/physical-context/name={value-name}/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-equipment" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-equipment" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/physical-context/physical-span={uuid}/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.PhysicalSpan" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of physical-span" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.PhysicalSpan" + schema: + $ref: "#/definitions/tapi.equipment.PhysicalSpan" + 400: + description: "Internal error" + /data/context/physical-context/physical-span={uuid}/abstract-strand={local-id}/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.AbstractStrand" + description: "Both the serial segments that form an end-end strand and the parallel\ + \ end-end strands." + parameters: + - name: "uuid" + in: "path" + description: "Id of physical-span" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of abstract-strand" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.AbstractStrand" + schema: + $ref: "#/definitions/tapi.equipment.AbstractStrand" + 400: + description: "Internal error" + ? /data/context/physical-context/physical-span={uuid}/abstract-strand={local-id}/adjacent-strand={physical-span-uuid},{abstract-strand-local-id}/ + : get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.AbstractStrandRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of physical-span" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of abstract-strand" + required: true + type: "string" + - name: "physical-span-uuid" + in: "path" + description: "Id of adjacent-strand" + required: true + type: "string" + - name: "abstract-strand-local-id" + in: "path" + description: "Id of adjacent-strand" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.AbstractStrandRef" + schema: + $ref: "#/definitions/tapi.equipment.AbstractStrandRef" + 400: + description: "Internal error" + ? /data/context/physical-context/physical-span={uuid}/abstract-strand={local-id}/connector-pin={connector-identification},{pin-identification},{equipment-uuid}/ + : get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.ConnectorPinAddress" + description: "A strand can end on two or more Pins (usually 2 pins, but a strand\ + \ my be spliced to split a signal). This model supports only 2 ended strands.\r\ + \n A abstract strand may be spliced at both ends and hence\ + \ have no direct relationship to pins or may be connected to pins at one or\ + \ both ends.\r\n In the essential model these Pins would be\ + \ on connectors that plug in to connectors on Equipments.\r\n \ + \ The AbstractStrand is extended to the pins of the AccessPort which are\ + \ the Pins on the Connectors of the Equipment.\r\n In some\ + \ cases it may not be relevant to represent the pin detail and hence the reference\ + \ is to a connector alone." + parameters: + - name: "uuid" + in: "path" + description: "Id of physical-span" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of abstract-strand" + required: true + type: "string" + - name: "connector-identification" + in: "path" + description: "Id of connector-pin" + required: true + type: "string" + - name: "pin-identification" + in: "path" + description: "Id of connector-pin" + required: true + type: "string" + - name: "equipment-uuid" + in: "path" + description: "Id of connector-pin" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.ConnectorPinAddress" + schema: + $ref: "#/definitions/tapi.equipment.ConnectorPinAddress" + 400: + description: "Internal error" + /data/context/physical-context/physical-span={uuid}/abstract-strand={local-id}/name={value-name}/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of physical-span" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of abstract-strand" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/physical-context/physical-span={uuid}/abstract-strand={local-id}/spliced-strand={physical-span-uuid},{abstract-strand-local-id}/ + : get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.AbstractStrandRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of physical-span" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of abstract-strand" + required: true + type: "string" + - name: "physical-span-uuid" + in: "path" + description: "Id of spliced-strand" + required: true + type: "string" + - name: "abstract-strand-local-id" + in: "path" + description: "Id of spliced-strand" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.AbstractStrandRef" + schema: + $ref: "#/definitions/tapi.equipment.AbstractStrandRef" + 400: + description: "Internal error" + /data/context/physical-context/physical-span={uuid}/abstract-strand={local-id}/strand-media-characteristics={value-name}/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.common.NameAndValue" + description: "Relevant physical properties of the abstract strand." + parameters: + - name: "uuid" + in: "path" + description: "Id of physical-span" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of abstract-strand" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of strand-media-characteristics" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/physical-context/physical-span={uuid}/access-port={device-uuid},{access-port-uuid}/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.AccessPortRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of physical-span" + required: true + type: "string" + - name: "device-uuid" + in: "path" + description: "Id of access-port" + required: true + type: "string" + - name: "access-port-uuid" + in: "path" + description: "Id of access-port" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.AccessPortRef" + schema: + $ref: "#/definitions/tapi.equipment.AccessPortRef" + 400: + description: "Internal error" + /data/context/physical-context/physical-span={uuid}/name={value-name}/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of physical-span" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/service-interface-point/: + post: + tags: + - "tapi-common" + summary: "creates tapi.common.ServiceInterfacePoint" + description: "none" + parameters: + - in: "body" + name: "tapi.common.ServiceInterfacePoint.body-param" + description: "tapi.common.ServiceInterfacePoint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/service-interface-point={uuid}/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.ServiceInterfacePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.ServiceInterfacePoint" + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + 400: + description: "Internal error" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.ServiceInterfacePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.ServiceInterfacePoint.body-param" + description: "tapi.common.ServiceInterfacePoint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-common" + summary: "removes tapi.common.ServiceInterfacePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/service-interface-point={uuid}/available-capacity/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/service-interface-point={uuid}/available-capacity/total-size/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/service-interface-point={uuid}/name/: + post: + tags: + - "tapi-common" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/service-interface-point={uuid}/name={value-name}/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-common" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/service-interface-point={uuid}/total-potential-capacity/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/service-interface-point={uuid}/total-potential-capacity/total-size/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: [] + responses: + 200: + description: "tapi.topology.TopologyContext" + schema: + $ref: "#/definitions/tapi.topology.TopologyContext" + 400: + description: "Internal error" + post: + tags: + - "tapi-topology" + summary: "creates tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: + - in: "body" + name: "tapi.topology.context.TopologyContext.body-param" + description: "tapi.topology.TopologyContext to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.topology.TopologyContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-topology" + summary: "creates or updates tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: + - in: "body" + name: "tapi.topology.context.TopologyContext.body-param" + description: "tapi.topology.TopologyContext to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.topology.TopologyContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-topology" + summary: "removes tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/topology-context/nw-topology-service/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NetworkTopologyService" + description: "none" + parameters: [] + responses: + 200: + description: "tapi.topology.NetworkTopologyService" + schema: + $ref: "#/definitions/tapi.topology.NetworkTopologyService" + 400: + description: "Internal error" + /data/context/topology-context/nw-topology-service/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/topology-context/nw-topology-service/topology={topology-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.TopologyRef" + description: "none" + parameters: + - name: "topology-uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.TopologyRef" + schema: + $ref: "#/definitions/tapi.topology.TopologyRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.topologycontext.Topology" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.topologycontext.Topology" + schema: + $ref: "#/definitions/tapi.topology.topologycontext.Topology" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/boundary-node-edge-point={topology-uuid},{node-uuid},{node-edge-point-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of boundary-node-edge-point" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of boundary-node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of boundary-node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.Link" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.Link" + schema: + $ref: "#/definitions/tapi.topology.Link" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/total-size/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/cost-characteristic={cost-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/latency-characteristic={traffic-property-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/link={link-uuid}/node-edge-point={topology-uuid},{node-uuid},{node-edge-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/risk-characteristic={risk-characteristic-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.RiskCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/total-size/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/validation-mechanism={validation-mechanism}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.ValidationMechanism" + description: "Provides details of the specific validation mechanism(s) used\ + \ to confirm the presence of an intended topologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "validation-mechanism" + in: "path" + description: "Id of validation-mechanism" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.ValidationMechanism" + schema: + $ref: "#/definitions/tapi.topology.ValidationMechanism" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.topology.Node" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.topology.Node" + schema: + $ref: "#/definitions/tapi.topology.topology.Node" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "aggregated-node-edge-point-node-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/total-size/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/cost-characteristic={cost-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/encap-topology/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.TopologyRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.TopologyRef" + schema: + $ref: "#/definitions/tapi.topology.TopologyRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/latency-characteristic={traffic-property-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.node.NodeEdgePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.node.NodeEdgePoint" + schema: + $ref: "#/definitions/tapi.topology.node.NodeEdgePoint" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{aggregated-node-edge-point-node-edge-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "aggregated-node-edge-point-node-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "aggregated-node-edge-point-node-edge-point-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-cep-layer-protocol={layer-protocol-qualifier}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NepLayerProtocolCapability" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "layer-protocol-qualifier" + in: "path" + description: "Id of available-cep-layer-protocol" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NepLayerProtocolCapability" + schema: + $ref: "#/definitions/tapi.topology.NepLayerProtocolCapability" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/mapped-service-interface-point={service-interface-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "NodeEdgePoint mapped to more than ServiceInterfacePoint (slicing/virtualizing)\ + \ or a ServiceInterfacePoint mapped to more than one NodeEdgePoint (load balancing/Resilience)\ + \ should be considered experimental" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "service-interface-point-uuid" + in: "path" + description: "Id of mapped-service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.ServiceInterfacePointRef" + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/supporting-access-port/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.SupportingAccessPort" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.SupportingAccessPort" + schema: + $ref: "#/definitions/tapi.equipment.SupportingAccessPort" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/supporting-access-port/access-port/ + : get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.AccessPortRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.AccessPortRef" + schema: + $ref: "#/definitions/tapi.equipment.AccessPortRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/total-potential-capacity/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/total-potential-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeRuleGroup" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeRuleGroup" + schema: + $ref: "#/definitions/tapi.topology.NodeRuleGroup" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/composed-rule-group={topology-uuid},{composed-rule-group-node-uuid},{composed-rule-group-node-rule-group-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeRuleGroupRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of composed-rule-group" + required: true + type: "string" + - name: "composed-rule-group-node-uuid" + in: "path" + description: "Id of composed-rule-group" + required: true + type: "string" + - name: "composed-rule-group-node-rule-group-uuid" + in: "path" + description: "Id of composed-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeRuleGroupRef" + schema: + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/cost-characteristic={cost-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.InterRuleGroup" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.InterRuleGroup" + schema: + $ref: "#/definitions/tapi.topology.InterRuleGroup" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/associated-node-rule-group={topology-uuid},{associated-node-rule-group-node-uuid},{associated-node-rule-group-node-rule-group-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeRuleGroupRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of associated-node-rule-group" + required: true + type: "string" + - name: "associated-node-rule-group-node-uuid" + in: "path" + description: "Id of associated-node-rule-group" + required: true + type: "string" + - name: "associated-node-rule-group-node-rule-group-uuid" + in: "path" + description: "Id of associated-node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeRuleGroupRef" + schema: + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/cost-characteristic={cost-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/latency-characteristic={traffic-property-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/name={value-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.RiskCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.Rule" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.Rule" + schema: + $ref: "#/definitions/tapi.topology.Rule" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/name={value-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/latency-characteristic={traffic-property-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/node-edge-point={topology-uuid},{node-edge-point-node-uuid},{node-edge-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "node-edge-point-node-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.RiskCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.Rule" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.Rule" + schema: + $ref: "#/definitions/tapi.topology.Rule" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/name={value-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/supporting-physical-span/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.SupportingPhysicalSpan" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.SupportingPhysicalSpan" + schema: + $ref: "#/definitions/tapi.equipment.SupportingPhysicalSpan" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/supporting-physical-span/physical-span/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.PhysicalSpanRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.PhysicalSpanRef" + schema: + $ref: "#/definitions/tapi.equipment.PhysicalSpanRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/total-size/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /operations/create-notification-subscription-service/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.CreateNotificationSubscriptionService" + description: "operates on tapi.notification.CreateNotificationSubscriptionService" + parameters: + - in: "body" + name: "tapi.notification.createnotificationsubscriptionservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.createnotificationsubscriptionservice.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.CreateNotificationSubscriptionService" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/delete-notification-subscription-service/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.DeleteNotificationSubscriptionService" + description: "operates on tapi.notification.DeleteNotificationSubscriptionService" + parameters: + - in: "body" + name: "tapi.notification.deletenotificationsubscriptionservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.deletenotificationsubscriptionservice.Input" + responses: + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-device-list/: + post: + tags: + - "tapi-equipment" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.equipment.GetDeviceList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-device/: + post: + tags: + - "tapi-equipment" + summary: "operates on tapi.equipment.GetDevice" + description: "operates on tapi.equipment.GetDevice" + parameters: + - in: "body" + name: "tapi.equipment.getdevice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.equipment.getdevice.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.equipment.GetDevice" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-link-details/: + post: + tags: + - "tapi-topology" + summary: "operates on tapi.topology.GetLinkDetails" + description: "operates on tapi.topology.GetLinkDetails" + parameters: + - in: "body" + name: "tapi.topology.getlinkdetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.topology.getlinkdetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetLinkDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-node-details/: + post: + tags: + - "tapi-topology" + summary: "operates on tapi.topology.GetNodeDetails" + description: "operates on tapi.topology.GetNodeDetails" + parameters: + - in: "body" + name: "tapi.topology.getnodedetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.topology.getnodedetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetNodeDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-node-edge-point-details/: + post: + tags: + - "tapi-topology" + summary: "operates on tapi.topology.GetNodeEdgePointDetails" + description: "operates on tapi.topology.GetNodeEdgePointDetails" + parameters: + - in: "body" + name: "tapi.topology.getnodeedgepointdetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.topology.getnodeedgepointdetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetNodeEdgePointDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-notification-list/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.GetNotificationList" + description: "operates on tapi.notification.GetNotificationList" + parameters: + - in: "body" + name: "tapi.notification.getnotificationlist.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.getnotificationlist.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.GetNotificationList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-notification-subscription-service-details/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.GetNotificationSubscriptionServiceDetails" + description: "operates on tapi.notification.GetNotificationSubscriptionServiceDetails" + parameters: + - in: "body" + name: "tapi.notification.getnotificationsubscriptionservicedetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.getnotificationsubscriptionservicedetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.GetNotificationSubscriptionServiceDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-notification-subscription-service-list/: + post: + tags: + - "tapi-notification" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.GetNotificationSubscriptionServiceList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-physical-span-list/: + post: + tags: + - "tapi-equipment" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.equipment.GetPhysicalSpanList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-physical-span/: + post: + tags: + - "tapi-equipment" + summary: "operates on tapi.equipment.GetPhysicalSpan" + description: "operates on tapi.equipment.GetPhysicalSpan" + parameters: + - in: "body" + name: "tapi.equipment.getphysicalspan.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.equipment.getphysicalspan.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.equipment.GetPhysicalSpan" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-service-interface-point-details/: + post: + tags: + - "tapi-common" + summary: "operates on tapi.common.GetServiceInterfacePointDetails" + description: "operates on tapi.common.GetServiceInterfacePointDetails" + parameters: + - in: "body" + name: "tapi.common.getserviceinterfacepointdetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.common.getserviceinterfacepointdetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.common.GetServiceInterfacePointDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-service-interface-point-list/: + post: + tags: + - "tapi-common" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.common.GetServiceInterfacePointList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-supported-notification-types/: + post: + tags: + - "tapi-notification" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.GetSupportedNotificationTypes" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-topology-details/: + post: + tags: + - "tapi-topology" + summary: "operates on tapi.topology.GetTopologyDetails" + description: "operates on tapi.topology.GetTopologyDetails" + parameters: + - in: "body" + name: "tapi.topology.gettopologydetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.topology.gettopologydetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetTopologyDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-topology-list/: + post: + tags: + - "tapi-topology" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetTopologyList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/update-notification-subscription-service/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.UpdateNotificationSubscriptionService" + description: "operates on tapi.notification.UpdateNotificationSubscriptionService" + parameters: + - in: "body" + name: "tapi.notification.updatenotificationsubscriptionservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.updatenotificationsubscriptionservice.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.UpdateNotificationSubscriptionService" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/update-service-interface-point/: + post: + tags: + - "tapi-common" + summary: "operates on tapi.common.UpdateServiceInterfacePoint" + description: "operates on tapi.common.UpdateServiceInterfacePoint" + parameters: + - in: "body" + name: "tapi.common.updateserviceinterfacepoint.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.common.updateserviceinterfacepoint.Input" + responses: + 201: + description: "No response" + 400: + description: "Internal error" +definitions: + tapi.common.AdminStatePac: + type: "object" + properties: + operational-state: + description: "none" + $ref: "#/definitions/tapi.common.OperationalState" + lifecycle-state: + description: "none" + $ref: "#/definitions/tapi.common.LifecycleState" + administrative-state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + tapi.common.AdministrativeState: + type: "string" + enum: + - "LOCKED" + - "UNLOCKED" + tapi.common.Capacity: + type: "object" + properties: + total-size: + description: "Total capacity of the TopologicalEntity in MB/s. In case of\ + \ bandwidthProfile, this is expected to same as the committedInformationRate." + $ref: "#/definitions/tapi.common.CapacityValue" + tapi.common.CapacityPac: + type: "object" + properties: + available-capacity: + description: "Capacity available to be assigned." + $ref: "#/definitions/tapi.common.Capacity" + total-potential-capacity: + description: "An optimistic view of the capacity of the TopologicalEntity\ + \ assuming that any shared capacity is available to be taken." + $ref: "#/definitions/tapi.common.Capacity" + tapi.common.CapacityUnit: + type: "string" + enum: + - "TB" + - "TBPS" + - "GB" + - "GBPS" + - "MB" + - "MBPS" + - "KB" + - "KBPS" + - "GHz" + - "MHz" + tapi.common.CapacityValue: + type: "object" + properties: + value: + type: "integer" + format: "int32" + description: "none" + unit: + description: "none" + $ref: "#/definitions/tapi.common.CapacityUnit" + tapi.common.Context: + allOf: + - $ref: "#/definitions/tapi.common.TapiContext" + - $ref: "#/definitions/tapi.equipment.ContextAugmentation2" + - $ref: "#/definitions/tapi.notification.ContextAugmentation1" + - $ref: "#/definitions/tapi.topology.ContextAugmentation3" + tapi.common.ForwardingDirection: + type: "string" + enum: + - "BIDIRECTIONAL" + - "UNIDIRECTIONAL" + - "UNDEFINED_OR_UNKNOWN" + tapi.common.GetServiceInterfacePointDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.common.getserviceinterfacepointdetails.Output" + tapi.common.GetServiceInterfacePointList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.common.getserviceinterfacepointlist.Output" + tapi.common.GlobalClass: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a UUID\ + \ in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.common.LayerProtocolName: + type: "string" + enum: + - "ODU" + - "ETH" + - "DSR" + - "PHOTONIC_MEDIA" + tapi.common.LifecycleState: + type: "string" + enum: + - "PLANNED" + - "POTENTIAL_AVAILABLE" + - "POTENTIAL_BUSY" + - "INSTALLED" + - "PENDING_REMOVAL" + tapi.common.LocalClass: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + local-id: + type: "string" + description: "none" + tapi.common.NameAndValue: + type: "object" + properties: + value-name: + type: "string" + description: "The name of the value. The value need not have a name." + value: + type: "string" + description: "The value" + tapi.common.OperationalState: + type: "string" + enum: + - "DISABLED" + - "ENABLED" + tapi.common.PortDirection: + type: "string" + enum: + - "BIDIRECTIONAL" + - "INPUT" + - "OUTPUT" + - "UNIDENTIFIED_OR_UNKNOWN" + tapi.common.PortRole: + type: "string" + enum: + - "SYMMETRIC" + - "ROOT" + - "LEAF" + - "TRUNK" + - "UNKNOWN" + tapi.common.ServiceInterfacePoint: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + supported-layer-protocol-qualifier: + type: "array" + description: "none" + items: + type: "string" + layer-protocol-name: + description: "Usage of layerProtocolName [>1] in the ServiceInterfacePoint\ + \ should be considered experimental" + $ref: "#/definitions/tapi.common.LayerProtocolName" + description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ + \ termination and adaptation functions of one or more transport layers. \r\ + \n The structure of LTP supports all transport protocols including\ + \ circuit and packet forms." + tapi.common.ServiceInterfacePointRef: + type: "object" + properties: + service-interface-point-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-common:service-interface-point/tapi-common:uuid" + tapi.common.TapiContext: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + service-interface-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + description: "The Network Control Domain (NCD) object class represents the scope\ + \ of control that a particular SDN controller has with respect to a particular\ + \ network, (i.e., encompassing a designated set of interconnected (virtual)\ + \ network elements)." + tapi.common.TerminationDirection: + type: "string" + enum: + - "BIDIRECTIONAL" + - "SINK" + - "SOURCE" + - "UNDEFINED_OR_UNKNOWN" + tapi.common.TerminationPac: + type: "object" + properties: + termination-direction: + description: "The overall directionality of the LP. \r\n -\ + \ A BIDIRECTIONAL LP will have some SINK and/or SOURCE flowss.\r\n \ + \ - A SINK LP can only contain elements with SINK flows or CONTRA_DIRECTION_SOURCE\ + \ flows\r\n - A SOURCE LP can only contain SOURCE flows or\ + \ CONTRA_DIRECTION_SINK flows" + $ref: "#/definitions/tapi.common.TerminationDirection" + termination-state: + description: "Indicates whether the layer is terminated and if so how." + $ref: "#/definitions/tapi.common.TerminationState" + tapi.common.TerminationState: + type: "string" + enum: + - "LP_CAN_NEVER_TERMINATE" + - "LT_NOT_TERMINATED" + - "TERMINATED_SERVER_TO_CLIENT_FLOW" + - "TERMINATED_CLIENT_TO_SERVER_FLOW" + - "TERMINATED_BIDIRECTIONAL" + - "LT_PERMENANTLY_TERMINATED" + - "TERMINATION_STATE_UNKNOWN" + tapi.common.TimeRange: + type: "object" + properties: + end-time: + type: "string" + description: "none" + start-time: + type: "string" + description: "none" + tapi.common.getserviceinterfacepointdetails.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.common.getserviceinterfacepointdetails.Output: + type: "object" + properties: + sip: + description: "none" + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + tapi.common.getserviceinterfacepointlist.Output: + type: "object" + properties: + sip: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + tapi.common.updateserviceinterfacepoint.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + tapi.equipment.AbstractStrand: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + strand-media-characteristics: + type: "array" + description: "Relevant physical properties of the abstract strand." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + connector-pin: + type: "array" + description: "A strand can end on two or more Pins (usually 2 pins, but\ + \ a strand my be spliced to split a signal). This model supports only\ + \ 2 ended strands.\r\n A abstract strand may be spliced\ + \ at both ends and hence have no direct relationship to pins or may be\ + \ connected to pins at one or both ends.\r\n In the essential\ + \ model these Pins would be on connectors that plug in to connectors on\ + \ Equipments.\r\n The AbstractStrand is extended to the\ + \ pins of the AccessPort which are the Pins on the Connectors of the Equipment.\r\ + \n In some cases it may not be relevant to represent the\ + \ pin detail and hence the reference is to a connector alone." + items: + $ref: "#/definitions/tapi.equipment.ConnectorPinAddress" + spliced-strand: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.equipment.AbstractStrandRef" + adjacent-strand: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.equipment.AbstractStrandRef" + description: "This object represents an abstraction of one or more strands in\ + \ series that provides sufficient detail to enable appropriate engineering.\r\ + \n A strand represents a continuous long, thin piece of a medium\ + \ such as glass fiber or copper wire.\r\n In this model a Strand:\r\ + \n - a strand has two ends\r\n - a splice can only be\ + \ between 2 strands.\r\n - the end of a strand may have a splice,\ + \ a connector or be hidden\r\n - only one end can be hidden in\ + \ an equipment\r\n - where a cable has more than two end each strand\ + \ only goes between two of the ends\r\n This model does NOT account\ + \ for multiple copper strands being spliced." + tapi.equipment.AbstractStrandRef: + allOf: + - $ref: "#/definitions/tapi.equipment.PhysicalSpanRef" + - type: "object" + properties: + abstract-strand-local-id: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-equipment:physical-context/tapi-equipment:physical-span/tapi-equipment:abstract-strand/tapi-equipment:local-id" + description: "none" + tapi.equipment.AccessPort: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + connector-pin: + type: "array" + description: "The list of Pins that support the AccessPort." + items: + $ref: "#/definitions/tapi.equipment.ConnectorPinAddress" + description: "A group of pins that together support a signal group where any\ + \ one pin removed from the group will prevent all signals of the signal group\ + \ from flowing successfully.\r\n In some cases the AccessPort may\ + \ simply reference a single connector (e.g., where the pin-connector association\ + \ is simpe such that the AccessPort references all pinsof one connector)." + tapi.equipment.AccessPortRef: + allOf: + - $ref: "#/definitions/tapi.equipment.DeviceRef" + - type: "object" + properties: + access-port-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-equipment:physical-context/tapi-equipment:device/tapi-equipment:access-port/tapi-equipment:uuid" + description: "none" + tapi.equipment.ActualEquipment: + type: "object" + properties: + common-actual-properties: + description: "none" + $ref: "#/definitions/tapi.equipment.CommonActualProperties" + actual-non-field-replaceable-module: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.equipment.ActualNonFieldReplaceableModule" + common-equipment-properties: + description: "none" + $ref: "#/definitions/tapi.equipment.CommonEquipmentProperties" + tapi.equipment.ActualHolder: + type: "object" + properties: + common-holder-properties: + description: "none" + $ref: "#/definitions/tapi.equipment.CommonHolderProperties" + tapi.equipment.ActualNonFieldReplaceableModule: + type: "object" + properties: + common-actual-properties: + description: "none" + $ref: "#/definitions/tapi.equipment.CommonActualProperties" + common-equipment-properties: + description: "none" + $ref: "#/definitions/tapi.equipment.CommonEquipmentProperties" + tapi.equipment.CommonActualProperties: + type: "object" + properties: + temperature: + type: "string" + description: "The measured temperature of the Equipment." + manufacture-date: + type: "string" + description: "This attribute represents the date on which this instance is\ + \ manufactured." + is-powered: + type: "boolean" + description: "The state of the power being supplied to the equipment.\r\n\ + \ Note that this attribute summarizes the power state. \r\ + \n Full details on the actual power system would be provided\ + \ from a number of PC instances representing the relevant parts of the Power\ + \ function (e.g. different voltage supplies)." + default: false + serial-number: + type: "string" + description: "This attribute represents the serial number of this instance." + asset-instance-identifier: + type: "string" + description: "This attribute represents the asset identifier of this instance\ + \ from the manufacturer's perspective." + tapi.equipment.CommonEquipmentProperties: + type: "object" + properties: + equipment-type-version: + type: "string" + description: "This attribute identifies the version of the equipment." + manufacturer-name: + type: "string" + description: "The formal name of the manufacturer of the Equipment." + equipment-type-description: + type: "string" + description: "Text describing the type of Equipment." + manufacturer-identifier: + type: "string" + description: "The formal unique identifier of the manufacturer." + equipment-type-name: + type: "string" + description: "This attribute identifies the type of the equipment." + equipment-type-identifier: + type: "string" + description: "This attribute identifies the part type of the equipment." + asset-type-identifier: + type: "string" + description: "Represents the invariant properties of the equipment asset allocated\ + \ by the operator that define and characterize the type." + tapi.equipment.CommonHolderProperties: + type: "object" + properties: + holder-location: + type: "string" + description: "The relative position of the holder in the context of its containing\ + \ equipment along with the position of that containing Equipment (and further\ + \ recursion)." + is-guided: + type: "boolean" + description: "This attribute indicates whether the holder has guides that\ + \ constrain the position of the equipment in the holder or not." + default: false + holder-category: + type: "string" + description: "The type of holder." + tapi.equipment.ConnectorPinAddress: + type: "object" + properties: + connector-identification: + type: "string" + description: "Identification of the Connector in the conetxt of the referenced\ + \ Equipment." + equipment-uuid: + type: "string" + description: "Reference to the Equipment that is fitted with the Connector/Pin." + pin-identification: + type: "string" + description: "Where relevant, identification of the Pin in the contect of\ + \ the connector.\r\n Where the whole connector is used, then\ + \ individual Pins need not be identified." + tapi.equipment.ContextAugmentation2: + type: "object" + properties: + physical-context: + description: "none" + $ref: "#/definitions/tapi.equipment.PhysicalContext" + x-augmentation: + prefix: "tapi-equipment" + namespace: "urn:onf:otcc:yang:tapi-equipment" + tapi.equipment.Device: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + equipment: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.equipment.Equipment" + access-port: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.equipment.AccessPort" + description: "A logical grouping of Equipments and AccessPorts that are closely\ + \ located and form a support a coherent system of related functions." + tapi.equipment.DeviceRef: + type: "object" + properties: + device-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-equipment:physical-context/tapi-equipment:device/tapi-equipment:uuid" + tapi.equipment.Equipment: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + contained-holder: + type: "array" + description: "References the Holder in an Equipment that is available to\ + \ take other Equipments.\r\n For example:\r\n \ + \ - Slot in a sub-rack\r\n - Slot in a Field Replaceable\ + \ Unit that can take a small form-factor pluggable." + items: + $ref: "#/definitions/tapi.equipment.Holder" + actual-equipment: + description: "none" + $ref: "#/definitions/tapi.equipment.ActualEquipment" + is-expected-actual-mismatch: + type: "boolean" + description: "none" + default: false + geographical-location: + type: "string" + description: "none" + expected-equipment: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.equipment.ExpectedEquipment" + equipment-location: + type: "string" + description: "none" + category: + type: "string" + description: "This attribute provides the identifier for the form of equipments\ + \ regarded as having particular shared characteristics." + description: "Represents any relevant physical thing. \r\n Can be\ + \ either field replaceable or not field replaceable.\r\n Note:\ + \ The model is currently constrained to inside plant." + tapi.equipment.EquipmentRef: + allOf: + - $ref: "#/definitions/tapi.equipment.DeviceRef" + - type: "object" + properties: + equipment-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-equipment:physical-context/tapi-equipment:device/tapi-equipment:equipment/tapi-equipment:uuid" + description: "none" + tapi.equipment.ExpectedEquipment: + type: "object" + properties: + expected-holder: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.equipment.ExpectedHolder" + expected-non-field-replaceable-module: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.equipment.ExpectedNonFieldReplaceableModule" + common-equipment-properties: + description: "none" + $ref: "#/definitions/tapi.equipment.CommonEquipmentProperties" + tapi.equipment.ExpectedHolder: + type: "object" + properties: + common-holder-properties: + description: "none" + $ref: "#/definitions/tapi.equipment.CommonHolderProperties" + tapi.equipment.ExpectedNonFieldReplaceableModule: + type: "object" + properties: + common-equipment-properties: + description: "none" + $ref: "#/definitions/tapi.equipment.CommonEquipmentProperties" + tapi.equipment.GetDevice: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.equipment.getdevice.Output" + tapi.equipment.GetDeviceList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.equipment.getdevicelist.Output" + tapi.equipment.GetPhysicalSpan: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.equipment.getphysicalspan.Output" + tapi.equipment.GetPhysicalSpanList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.equipment.getphysicalspanlist.Output" + tapi.equipment.Holder: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + expected-holder: + description: "none" + $ref: "#/definitions/tapi.equipment.ExpectedHolder" + actual-holder: + description: "none" + $ref: "#/definitions/tapi.equipment.ActualHolder" + occupying-fru: + description: "The FRU that is occupying the holder. \r\n \ + \ A holder may be unoccupied. \r\n An FRU may occupy more\ + \ hat one holder (using or blocking are intentionally not distinguished\ + \ here)." + $ref: "#/definitions/tapi.equipment.EquipmentRef" + description: "Represents a space in an equipment in which another equipment\ + \ can be fitted in the field." + tapi.equipment.NodeAugmentation1: + type: "object" + properties: + supporting-physical-span: + description: "none" + $ref: "#/definitions/tapi.equipment.SupportingPhysicalSpan" + x-augmentation: + prefix: "tapi-equipment" + namespace: "urn:onf:otcc:yang:tapi-equipment" + tapi.equipment.NodeEdgePointAugmentation1: + type: "object" + properties: + supporting-access-port: + description: "none" + $ref: "#/definitions/tapi.equipment.SupportingAccessPort" + x-augmentation: + prefix: "tapi-equipment" + namespace: "urn:onf:otcc:yang:tapi-equipment" + tapi.equipment.PhysicalContext: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + device: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.equipment.Device" + physical-span: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.equipment.PhysicalSpan" + description: "none" + tapi.equipment.PhysicalSpan: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + abstract-strand: + type: "array" + description: "Both the serial segments that form an end-end strand and the\ + \ parallel end-end strands." + items: + $ref: "#/definitions/tapi.equipment.AbstractStrand" + access-port: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.equipment.AccessPortRef" + description: "An adjacency between AccessPorts. \r\n The adjacency\ + \ is supported by a group of strands between pins of the AccessPorts.\r\n\ + \ This is a physical abstraction." + tapi.equipment.PhysicalSpanRef: + type: "object" + properties: + physical-span-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-equipment:physical-context/tapi-equipment:physical-span/tapi-equipment:uuid" + tapi.equipment.SupportingAccessPort: + type: "object" + properties: + access-port: + description: "none" + $ref: "#/definitions/tapi.equipment.AccessPortRef" + tapi.equipment.SupportingPhysicalSpan: + type: "object" + properties: + physical-span: + description: "none" + $ref: "#/definitions/tapi.equipment.PhysicalSpanRef" + tapi.equipment.getdevice.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.equipment.getdevice.Output: + type: "object" + properties: + device: + description: "none" + $ref: "#/definitions/tapi.equipment.Device" + tapi.equipment.getdevicelist.Output: + type: "object" + properties: + device: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.equipment.Device" + tapi.equipment.getphysicalspan.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.equipment.getphysicalspan.Output: + type: "object" + properties: + physical-span: + description: "none" + $ref: "#/definitions/tapi.equipment.PhysicalSpan" + tapi.equipment.getphysicalspanlist.Output: + type: "object" + properties: + physical-span: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.equipment.PhysicalSpan" + tapi.notification.ContextAugmentation1: + type: "object" + properties: + notification-context: + description: "Augments the base TAPI Context with NotificationService information" + $ref: "#/definitions/tapi.notification.NotificationContext" + x-augmentation: + prefix: "tapi-notification" + namespace: "urn:onf:otcc:yang:tapi-notification" + tapi.notification.CreateNotificationSubscriptionService: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.createnotificationsubscriptionservice.Output" + tapi.notification.GetNotificationList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.getnotificationlist.Output" + tapi.notification.GetNotificationSubscriptionServiceDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.getnotificationsubscriptionservicedetails.Output" + tapi.notification.GetNotificationSubscriptionServiceList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.getnotificationsubscriptionservicelist.Output" + tapi.notification.GetSupportedNotificationTypes: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.getsupportednotificationtypes.Output" + tapi.notification.NameAndValueChange: + type: "object" + properties: + value-name: + type: "string" + description: "The name of the value. The value need not have a name." + old-value: + type: "string" + description: "The value" + new-value: + type: "string" + description: "The value" + tapi.notification.Notification: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + target-object-type: + type: "string" + description: "none" + additional-text: + type: "string" + description: "none" + event-time-stamp: + type: "string" + description: "none" + additional-info: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.NameAndValue" + sequence-number: + type: "integer" + format: "int32" + description: "A monotonous increasing sequence number associated with the\ + \ notification.\r\n The exact semantics of how this sequence\ + \ number is assigned (per channel or subscription or source or system)\ + \ is left undefined." + target-object-identifier: + type: "string" + description: "none" + notification-type: + type: "string" + description: "none" + target-object-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.NameAndValue" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + source-indicator: + description: "none" + $ref: "#/definitions/tapi.notification.SourceIndicator" + layer-protocol-qualifier: + type: "string" + description: "none" + changed-attributes: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.NameAndValueChange" + description: "none" + tapi.notification.NotificationChannel: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + next-sequence-no: + type: "integer" + format: "int32" + description: "The sequence number of the next notification that will be\ + \ published on the channel" + stream-address: + type: "string" + description: "The address/location/URI of the channel/stream to which the\ + \ subscribed notifications are published.\r\n This specifics\ + \ of this is typically dependent on the implementation protocol & mechanism\ + \ and hence is typed as a string." + description: "none" + tapi.notification.NotificationContext: + type: "object" + properties: + notif-subscription: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + notification: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.Notification" + tapi.notification.NotificationSubscriptionService: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + notification: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.Notification" + notification-channel: + description: "none" + $ref: "#/definitions/tapi.notification.NotificationChannel" + subscription-state: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionState" + supported-object-types: + type: "array" + description: "none" + items: + type: "string" + supported-notification-types: + type: "array" + description: "none" + items: + type: "string" + subscription-filter: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + description: "none" + tapi.notification.SourceIndicator: + type: "string" + enum: + - "RESOURCE_OPERATION" + - "MANAGEMENT_OPERATION" + - "UNKNOWN" + tapi.notification.SubscriptionFilter: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + requested-notification-types: + type: "array" + description: "none" + items: + type: "string" + requested-object-identifier: + type: "array" + description: "none" + items: + type: "string" + requested-layer-protocols: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + include-content: + type: "boolean" + description: "Indicates whether the published Notification includes content\ + \ or just the Notification Id (which enables retrieval of the notification\ + \ at the later stage)" + default: false + requested-object-types: + type: "array" + description: "none" + items: + type: "string" + description: "none" + tapi.notification.SubscriptionState: + type: "string" + enum: + - "SUSPENDED" + - "ACTIVE" + tapi.notification.UpdateNotificationSubscriptionService: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.updatenotificationsubscriptionservice.Output" + tapi.notification.createnotificationsubscriptionservice.Input: + type: "object" + properties: + subscription-state: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionState" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + subscription-filter: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + tapi.notification.createnotificationsubscriptionservice.Output: + type: "object" + properties: + subscription-service: + description: "none" + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + tapi.notification.deletenotificationsubscriptionservice.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.notification.getnotificationlist.Input: + type: "object" + properties: + time-range: + description: "none" + $ref: "#/definitions/tapi.common.TimeRange" + subscription-id: + type: "string" + description: "UUID of the associated Notification Subscription Service: An\ + \ identifier that is universally unique within an identifier space, where\ + \ the identifier space is itself globally unique, and immutable.\r\n \ + \ An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.notification.getnotificationlist.Output: + type: "object" + properties: + notification: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.Notification" + tapi.notification.getnotificationsubscriptionservicedetails.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.notification.getnotificationsubscriptionservicedetails.Output: + type: "object" + properties: + subscription-service: + description: "none" + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + tapi.notification.getnotificationsubscriptionservicelist.Output: + type: "object" + properties: + subscription-service: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + tapi.notification.getsupportednotificationtypes.Output: + type: "object" + properties: + supported-object-types: + type: "array" + description: "none" + items: + type: "string" + supported-notification-types: + type: "array" + description: "none" + items: + type: "string" + tapi.notification.updatenotificationsubscriptionservice.Input: + type: "object" + properties: + subscription-state: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionState" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + subscription-filter: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + tapi.notification.updatenotificationsubscriptionservice.Output: + type: "object" + properties: + subscription-service: + description: "none" + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + tapi.topology.ContextAugmentation3: + type: "object" + properties: + topology-context: + description: "Augments the base TAPI Context with TopologyService information" + $ref: "#/definitions/tapi.topology.TopologyContext" + x-augmentation: + prefix: "tapi-topology" + namespace: "urn:onf:otcc:yang:tapi-topology" + tapi.topology.CostCharacteristic: + type: "object" + properties: + cost-value: + type: "string" + description: "The specific cost." + cost-algorithm: + type: "string" + description: "The cost may vary based upon some properties of the TopologicalEntity.\ + \ The rules for the variation are conveyed by the costAlgorithm." + cost-name: + type: "string" + description: "The cost characteristic will related to some aspect of the TopologicalEntity\ + \ (e.g. $ cost, routing weight). This aspect will be conveyed by the costName." + tapi.topology.ForwardingRule: + type: "string" + enum: + - "MAY_FORWARD_ACROSS_GROUP" + - "MUST_FORWARD_ACROSS_GROUP" + - "CANNOT_FORWARD_ACROSS_GROUP" + - "NO_STATEMENT_ON_FORWARDING" + tapi.topology.GetLinkDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.getlinkdetails.Output" + tapi.topology.GetNodeDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.getnodedetails.Output" + tapi.topology.GetNodeEdgePointDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.getnodeedgepointdetails.Output" + tapi.topology.GetTopologyDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.gettopologydetails.Output" + tapi.topology.GetTopologyList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.gettopologylist.Output" + tapi.topology.InterRuleGroup: + allOf: + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.topology.RiskParameterPac" + - $ref: "#/definitions/tapi.topology.TransferCostPac" + - $ref: "#/definitions/tapi.topology.TransferTimingPac" + - type: "object" + properties: + associated-node-rule-group: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + rule: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Rule" + description: "none" + tapi.topology.LatencyCharacteristic: + type: "object" + properties: + traffic-property-name: + type: "string" + description: "The identifier of the specific traffic property to which the\ + \ queuing latency applies." + jitter-characteristic: + type: "string" + description: "High frequency deviation from true periodicity of a signal and\ + \ therefore a small high rate of change of transfer latency.\r\n \ + \ Applies to TDM systems (and not packet)." + fixed-latency-characteristic: + type: "string" + description: "A TopologicalEntity suffers delay caused by the realization\ + \ of the servers (e.g. distance related; FEC encoding etc.) along with some\ + \ client specific processing. This is the total average latency effect of\ + \ the TopologicalEntity" + wander-characteristic: + type: "string" + description: "Low frequency deviation from true periodicity of a signal and\ + \ therefore a small low rate of change of transfer latency.\r\n \ + \ Applies to TDM systems (and not packet)." + queing-latency-characteristic: + type: "string" + description: "The specific queuing latency for the traffic property." + tapi.topology.LayerProtocolTransitionPac: + type: "object" + properties: + transitioned-layer-protocol-name: + type: "array" + description: "Provides the ordered structure of layer protocol transitions\ + \ encapsulated in the TopologicalEntity. The ordering relates to the LinkPort\ + \ role." + items: + type: "string" + tapi.topology.Link: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.topology.LayerProtocolTransitionPac" + - $ref: "#/definitions/tapi.topology.RiskParameterPac" + - $ref: "#/definitions/tapi.topology.TransferCostPac" + - $ref: "#/definitions/tapi.topology.TransferIntegrityPac" + - $ref: "#/definitions/tapi.topology.TransferTimingPac" + - $ref: "#/definitions/tapi.topology.ValidationPac" + - type: "object" + properties: + layer-protocol-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + restoration-policy: + description: "none" + $ref: "#/definitions/tapi.topology.RestorationPolicy" + node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + protection-type: + description: "none" + $ref: "#/definitions/tapi.topology.ProtectionType" + direction: + description: "The directionality of the Link. \r\n Is applicable\ + \ to simple Links where all LinkEnds are BIDIRECTIONAL (the Link will\ + \ be BIDIRECTIONAL) or UNIDIRECTIONAL (the Link will be UNIDIRECTIONAL).\ + \ \r\n Is not present in more complex cases." + $ref: "#/definitions/tapi.common.ForwardingDirection" + description: "The Link object class models effective adjacency between two or\ + \ more ForwardingDomains (FD). " + tapi.topology.NepLayerProtocolCapability: + type: "object" + properties: + layer-protocol-qualifier: + type: "string" + description: "none" + number-of-cep-instances: + type: "integer" + format: "int32" + description: "none" + tapi.topology.NetworkTopologyService: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + topology: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.TopologyRef" + description: "none" + tapi.topology.Node: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.topology.TransferCostPac" + - $ref: "#/definitions/tapi.topology.TransferIntegrityPac" + - $ref: "#/definitions/tapi.topology.TransferTimingPac" + - type: "object" + properties: + layer-protocol-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + encap-topology: + description: "none" + $ref: "#/definitions/tapi.topology.TopologyRef" + node-rule-group: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeRuleGroup" + node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePoint" + aggregated-node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + description: "The ForwardingDomain (FD) object class models the ForwardingDomain\ + \ topological component which is used to effect forwarding of transport characteristic\ + \ information and offers the potential to enable forwarding. \r\n \ + \ At the lowest level of recursion, an FD (within a network element (NE))\ + \ represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ + \ multiple switch matrices (FDs). " + tapi.topology.NodeEdgePoint: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.common.TerminationPac" + - type: "object" + properties: + link-port-role: + description: "Each LinkEnd of the Link has a role (e.g., symmetric, hub,\ + \ spoke, leaf, root) in the context of the Link with respect to the Link\ + \ function. " + $ref: "#/definitions/tapi.common.PortRole" + mapped-service-interface-point: + type: "array" + description: "NodeEdgePoint mapped to more than ServiceInterfacePoint (slicing/virtualizing)\ + \ or a ServiceInterfacePoint mapped to more than one NodeEdgePoint (load\ + \ balancing/Resilience) should be considered experimental" + items: + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + available-cep-layer-protocol: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NepLayerProtocolCapability" + aggregated-node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + link-port-direction: + description: "The orientation of defined flow at the LinkEnd." + $ref: "#/definitions/tapi.common.PortDirection" + description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ + \ termination and adaptation functions of one or more transport layers. \r\ + \n The structure of LTP supports all transport protocols including\ + \ circuit and packet forms." + tapi.topology.NodeEdgePointRef: + allOf: + - $ref: "#/definitions/tapi.topology.NodeRef" + - type: "object" + properties: + node-edge-point-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:node-edge-point/tapi-topology:uuid" + description: "none" + tapi.topology.NodeRef: + allOf: + - $ref: "#/definitions/tapi.topology.TopologyRef" + - type: "object" + properties: + node-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:uuid" + description: "none" + tapi.topology.NodeRuleGroup: + allOf: + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.topology.RiskParameterPac" + - $ref: "#/definitions/tapi.topology.TransferCostPac" + - $ref: "#/definitions/tapi.topology.TransferTimingPac" + - type: "object" + properties: + inter-rule-group: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.InterRuleGroup" + rule: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Rule" + composed-rule-group: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + description: "none" + tapi.topology.NodeRuleGroupRef: + allOf: + - $ref: "#/definitions/tapi.topology.NodeRef" + - type: "object" + properties: + node-rule-group-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:node-rule-group/tapi-topology:uuid" + description: "none" + tapi.topology.ProtectionType: + type: "string" + enum: + - "NO_PROTECTION" + - "ONE_PLUS_ONE_PROTECTION" + - "ONE_FOR_ONE_PROTECTION" + - "ONE_FOR_N_PROTECTION" + - "M_FOR_N_PROTECTION" + - "ONE_FOR_ONE_BY_N" + tapi.topology.RestorationPolicy: + type: "string" + enum: + - "PER_DOMAIN_RESTORATION" + - "END_TO_END_RESTORATION" + - "NA" + - "DYNAMIC_RESTORATION" + - "PRE_COMPUTED_RESTORATION" + tapi.topology.RiskCharacteristic: + type: "object" + properties: + risk-characteristic-name: + type: "string" + description: "The name of the risk characteristic. The characteristic may\ + \ be related to a specific degree of closeness. \r\n For\ + \ example a particular characteristic may apply to failures that are localized\ + \ (e.g. to one side of a road) where as another characteristic may relate\ + \ to failures that have a broader impact (e.g. both sides of a road that\ + \ crosses a bridge).\r\n Depending upon the importance of\ + \ the traffic being routed different risk characteristics will be evaluated." + risk-identifier-list: + type: "array" + description: "A list of the identifiers of each physical/geographic unit (with\ + \ the specific risk characteristic) that is related to a segment of the\ + \ TopologicalEntity." + items: + type: "string" + tapi.topology.RiskParameterPac: + type: "object" + properties: + risk-characteristic: + type: "array" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." + items: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" + tapi.topology.Rule: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + override-priority: + type: "integer" + format: "int32" + description: "none" + forwarding-rule: + description: "none" + $ref: "#/definitions/tapi.topology.ForwardingRule" + rule-type: + description: "none" + $ref: "#/definitions/tapi.topology.RuleType" + description: "none" + tapi.topology.RuleType: + type: "string" + enum: + - "FORWARDING" + - "CAPACITY" + - "COST" + - "TIMING" + - "RISK" + - "GROUPING" + tapi.topology.Topology: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + layer-protocol-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + link: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Link" + node: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Node" + boundary-node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + description: "The ForwardingDomain (FD) object class models the ForwardingDomain\ + \ topological component which is used to effect forwarding of transport characteristic\ + \ information and offers the potential to enable forwarding. \r\n \ + \ At the lowest level of recursion, an FD (within a network element (NE))\ + \ represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ + \ multiple switch matrices (FDs). " + tapi.topology.TopologyContext: + type: "object" + properties: + nw-topology-service: + description: "none" + $ref: "#/definitions/tapi.topology.NetworkTopologyService" + topology: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Topology" + tapi.topology.TopologyRef: + type: "object" + properties: + topology-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:uuid" + tapi.topology.TransferCostPac: + type: "object" + properties: + cost-characteristic: + type: "array" + description: "The list of costs where each cost relates to some aspect of\ + \ the TopologicalEntity." + items: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + tapi.topology.TransferIntegrityPac: + type: "object" + properties: + error-characteristic: + type: "string" + description: "Describes the degree to which the signal propagated can be errored.\ + \ \r\n Applies to TDM systems as the errored signal will\ + \ be propagated and not packet as errored packets will be discarded." + unavailable-time-characteristic: + type: "string" + description: "Describes the duration for which there may be no valid signal\ + \ propagated." + server-integrity-process-characteristic: + type: "string" + description: "Describes the effect of any server integrity enhancement process\ + \ on the characteristics of the TopologicalEntity." + delivery-order-characteristic: + type: "string" + description: "Describes the degree to which packets will be delivered out\ + \ of sequence.\r\n Does not apply to TDM as the TDM protocols\ + \ maintain strict order." + repeat-delivery-characteristic: + type: "string" + description: "Primarily applies to packet systems where a packet may be delivered\ + \ more than once (in fault recovery for example). \r\n It\ + \ can also apply to TDM where several frames may be received twice due to\ + \ switching in a system with a large differential propagation delay." + loss-characteristic: + type: "string" + description: "Describes the acceptable characteristic of lost packets where\ + \ loss may result from discard due to errors or overflow.\r\n \ + \ Applies to packet systems and not TDM (as for TDM errored signals\ + \ are propagated unless grossly errored and overflow/underflow turns into\ + \ timing slips)." + tapi.topology.TransferTimingPac: + type: "object" + properties: + latency-characteristic: + type: "array" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + items: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + tapi.topology.ValidationMechanism: + type: "object" + properties: + layer-protocol-adjacency-validated: + type: "string" + description: "State of validatiion" + validation-mechanism: + type: "string" + description: "Name of mechanism used to validate adjacency" + validation-robustness: + type: "string" + description: "Quality of validation (i.e. how likely is the stated validation\ + \ to be invalid)" + tapi.topology.ValidationPac: + type: "object" + properties: + validation-mechanism: + type: "array" + description: "Provides details of the specific validation mechanism(s) used\ + \ to confirm the presence of an intended topologicalEntity." + items: + $ref: "#/definitions/tapi.topology.ValidationMechanism" + tapi.topology.getlinkdetails.Input: + type: "object" + properties: + link-id: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.topology.getlinkdetails.Output: + type: "object" + properties: + link: + description: "none" + $ref: "#/definitions/tapi.topology.Link" + tapi.topology.getnodedetails.Input: + type: "object" + properties: + node-id: + type: "string" + description: "UUID of the Node: An identifier that is universally unique within\ + \ an identifier space, where the identifier space is itself globally unique,\ + \ and immutable.\r\n An UUID carries no semantics with\ + \ respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC 4122. The canonical\ + \ representation uses lowercase characters.\r\n Pattern:\ + \ [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\ + \ \r\n Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.topology.getnodedetails.Output: + type: "object" + properties: + node: + description: "none" + $ref: "#/definitions/tapi.topology.Node" + tapi.topology.getnodeedgepointdetails.Input: + type: "object" + properties: + node-id: + type: "string" + description: "UUID of the parent Node: An identifier that is universally unique\ + \ within an identifier space, where the identifier space is itself globally\ + \ unique, and immutable.\r\n An UUID carries no semantics\ + \ with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC 4122. The\ + \ canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\ + \ \r\n Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Node's Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + node-edge-point-id: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.topology.getnodeedgepointdetails.Output: + type: "object" + properties: + node-edge-point: + description: "none" + $ref: "#/definitions/tapi.topology.NodeEdgePoint" + tapi.topology.gettopologydetails.Input: + type: "object" + properties: + topology-id: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.topology.gettopologydetails.Output: + type: "object" + properties: + topology: + description: "none" + $ref: "#/definitions/tapi.topology.Topology" + tapi.topology.gettopologylist.Output: + type: "object" + properties: + topology: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Topology" + tapi.topology.node.NodeEdgePoint: + allOf: + - $ref: "#/definitions/tapi.equipment.NodeEdgePointAugmentation1" + - $ref: "#/definitions/tapi.topology.NodeEdgePoint" + tapi.topology.topology.Node: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.equipment.NodeAugmentation1" + - $ref: "#/definitions/tapi.topology.TransferCostPac" + - $ref: "#/definitions/tapi.topology.TransferIntegrityPac" + - $ref: "#/definitions/tapi.topology.TransferTimingPac" + - type: "object" + properties: + layer-protocol-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + encap-topology: + description: "none" + $ref: "#/definitions/tapi.topology.TopologyRef" + node-rule-group: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeRuleGroup" + node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.node.NodeEdgePoint" + aggregated-node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + description: "none" + tapi.topology.topologycontext.Topology: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + layer-protocol-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + link: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Link" + node: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.topology.Node" + boundary-node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + description: "none" diff --git a/OAS/tapi-eth@2018-12-10.yaml b/OAS/tapi-eth@2019-03-31.yaml similarity index 61% rename from OAS/tapi-eth@2018-12-10.yaml rename to OAS/tapi-eth@2019-03-31.yaml index 326ad14e..779fe2db 100644 --- a/OAS/tapi-eth@2018-12-10.yaml +++ b/OAS/tapi-eth@2019-03-31.yaml @@ -1,10 +1,137 @@ --- swagger: "2.0" info: - description: "tapi-oam,tapi-path-computation,tapi-connectivity,tapi-dsr,tapi-notification,tapi-topology,tapi-eth,tapi-common\ - \ API generated from yang definitions" - version: "1.0" - title: "tapi-oam,tapi-path-computation,tapi-connectivity,tapi-dsr,tapi-notification,tapi-topology,tapi-eth,tapi-common\ + description: "\r\n This module contains TAPI Notification Model definitions.\r\ + \n Source: TapiNotification.uml\r\n Copyright (c) 2018 Open Networking\ + \ Foundation (ONF). All rights reserved.\r\n License: This module is distributed\ + \ under the Apache License 2.0\r\n - The TAPI YANG models included in this\ + \ TAPI release are a *normative* part of the TAPI SDK.\r\n - The YANG specifications\ + \ have been generated from the corresponding UML model using the [ONF EAGLE UML2YANG\ + \ mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Topology\ + \ Model definitions.\r\n Source: TapiTopology.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI ETH Model\ + \ definitions.\r\n Source: TapiEth.uml\r\n Copyright (c) 2018 Open\ + \ Networking Foundation (ONF). All rights reserved.\r\n License: This module\ + \ is distributed under the Apache License 2.0\r\n - The TAPI YANG models\ + \ included in this TAPI release are a *normative* part of the TAPI SDK.\r\n \ + \ - The YANG specifications have been generated from the corresponding UML\ + \ model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI DSR Model\ + \ definitions.\r\n Source: TapiDsr.uml\r\n Copyright (c) 2018 Open\ + \ Networking Foundation (ONF). All rights reserved.\r\n License: This module\ + \ is distributed under the Apache License 2.0\r\n - The TAPI YANG models\ + \ included in this TAPI release are a *normative* part of the TAPI SDK.\r\n \ + \ - The YANG specifications have been generated from the corresponding UML\ + \ model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Common Model\ + \ definitions.\r\n Source: TapiCommon.uml\r\n Copyright (c) 2018\ + \ Open Networking Foundation (ONF). All rights reserved.\r\n License: This\ + \ module is distributed under the Apache License 2.0\r\n - The TAPI YANG\ + \ models included in this TAPI release are a *normative* part of the TAPI SDK.\r\ + \n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Path Computation\ + \ Model definitions.\r\n Source: TapiPathComputation.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Connectivity\ + \ Model definitions.\r\n Source: TapiConnectivity.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI OAM Model\ + \ definitions.\r\n Source: TapiOam.uml\r\n Copyright (c) 2018 Open\ + \ Networking Foundation (ONF). All rights reserved.\r\n License: This module\ + \ is distributed under the Apache License 2.0\r\n - The TAPI YANG models\ + \ included in this TAPI release are a *normative* part of the TAPI SDK.\r\n \ + \ - The YANG specifications have been generated from the corresponding UML\ + \ model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases." + version: "2.2.0" + title: "tapi-notification,tapi-topology,tapi-eth,tapi-dsr,tapi-common,tapi-path-computation,tapi-connectivity,tapi-oam\ \ API" host: "localhost:1234" consumes: @@ -16,7 +143,8 @@ paths: get: tags: - "tapi-common" - description: "returns tapi.common.Context" + summary: "returns tapi.common.Context" + description: "none" parameters: [] responses: 200: @@ -28,7 +156,8 @@ paths: post: tags: - "tapi-common" - description: "creates tapi.common.Context" + summary: "creates tapi.common.Context" + description: "none" parameters: - in: "body" name: "tapi.common.Context.body-param" @@ -46,7 +175,8 @@ paths: put: tags: - "tapi-common" - description: "creates or updates tapi.common.Context" + summary: "creates or updates tapi.common.Context" + description: "none" parameters: - in: "body" name: "tapi.common.Context.body-param" @@ -64,7 +194,8 @@ paths: delete: tags: - "tapi-common" - description: "removes tapi.common.Context" + summary: "removes tapi.common.Context" + description: "none" parameters: [] responses: 400: @@ -75,26 +206,29 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityContext" + summary: "returns tapi.connectivity.context.ConnectivityContext" + description: "Augments the base TAPI Context with ConnectivityService information" parameters: [] responses: 200: - description: "tapi.connectivity.ConnectivityContext" + description: "tapi.connectivity.context.ConnectivityContext" schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityContext" + $ref: "#/definitions/tapi.connectivity.context.ConnectivityContext" 400: description: "Internal error" post: tags: - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityContext" + summary: "creates tapi.connectivity.context.ConnectivityContext" + description: "Augments the base TAPI Context with ConnectivityService information" parameters: - in: "body" - name: "tapi.connectivity.ConnectivityContext.body-param" - description: "tapi.connectivity.ConnectivityContext to be added to list" + name: "tapi.connectivity.context.ConnectivityContext.body-param" + description: "tapi.connectivity.context.ConnectivityContext to be added to\ + \ list" required: false schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityContext" + $ref: "#/definitions/tapi.connectivity.context.ConnectivityContext" responses: 201: description: "Object created" @@ -105,14 +239,16 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityContext" + summary: "creates or updates tapi.connectivity.context.ConnectivityContext" + description: "Augments the base TAPI Context with ConnectivityService information" parameters: - in: "body" - name: "tapi.connectivity.ConnectivityContext.body-param" - description: "tapi.connectivity.ConnectivityContext to be added or updated" + name: "tapi.connectivity.context.ConnectivityContext.body-param" + description: "tapi.connectivity.context.ConnectivityContext to be added or\ + \ updated" required: false schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityContext" + $ref: "#/definitions/tapi.connectivity.context.ConnectivityContext" responses: 201: description: "Object created" @@ -123,7 +259,8 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityContext" + summary: "removes tapi.connectivity.context.ConnectivityContext" + description: "Augments the base TAPI Context with ConnectivityService information" parameters: [] responses: 400: @@ -134,7 +271,8 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.Connection" + summary: "returns tapi.connectivity.Connection" + description: "none" parameters: - name: "uuid" in: "path" @@ -148,11 +286,31 @@ paths: $ref: "#/definitions/tapi.connectivity.Connection" 400: description: "Internal error" + /data/context/connectivity-context/connection={uuid}/bounding-node/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.topology.NodeRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connection" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeRef" + schema: + $ref: "#/definitions/tapi.topology.NodeRef" + 400: + description: "Internal error" ? /data/context/connectivity-context/connection={uuid}/connection-end-point={topology-uuid},{node-uuid},{node-edge-point-uuid},{connection-end-point-uuid}/ : get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionEndPointRef" + summary: "returns tapi.connectivity.ConnectionEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -190,7 +348,14 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionRef" + summary: "returns tapi.connectivity.ConnectionRef" + description: "An Connection object supports a recursive aggregation relationship\ + \ such that the internal construction of an Connection can be exposed as multiple\ + \ lower level Connection objects (partitioning).\r\n Aggregation\ + \ is used as for the Node/Topology to allow changes in hierarchy. \r\n \ + \ Connection aggregation reflects Node/Topology aggregation.\ + \ \r\n The FC represents a Cross-Connection in an NE. The Cross-Connection\ + \ in an NE is not necessarily the lowest level of FC partitioning." parameters: - name: "uuid" in: "path" @@ -213,7 +378,10 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -236,7 +404,8 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.Route" + summary: "returns tapi.connectivity.Route" + description: "none" parameters: - name: "uuid" in: "path" @@ -259,7 +428,8 @@ paths: : get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionEndPointRef" + summary: "returns tapi.connectivity.ConnectionEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -302,7 +472,10 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -330,7 +503,8 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.topology.LinkRef" + summary: "returns tapi.topology.LinkRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -358,7 +532,8 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.SwitchControl" + summary: "returns tapi.connectivity.SwitchControl" + description: "none" parameters: - name: "uuid" in: "path" @@ -381,7 +556,10 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -405,34 +583,12 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/resilience-type/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.ResilienceType" - parameters: - - name: "uuid" - in: "path" - description: "Id of connection" - required: true - type: "string" - - name: "switch-control-uuid" - in: "path" - description: "Id of switch-control" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.ResilienceType" - schema: - $ref: "#/definitions/tapi.topology.ResilienceType" - 400: - description: "Internal error" ? /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/sub-switch-control={connection-uuid},{sub-switch-control-switch-control-uuid}/ : get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.SwitchControlRef" + summary: "returns tapi.connectivity.SwitchControlRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -465,7 +621,8 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.Switch" + summary: "returns tapi.connectivity.Switch" + description: "none" parameters: - name: "uuid" in: "path" @@ -493,7 +650,10 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -526,7 +686,8 @@ paths: : get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionEndPointRef" + summary: "returns tapi.connectivity.ConnectionEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -574,7 +735,8 @@ paths: : get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.RouteRef" + summary: "returns tapi.connectivity.RouteRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -612,14 +774,16 @@ paths: post: tags: - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityService" + summary: "creates tapi.connectivity.connectivitycontext.ConnectivityService" + description: "none" parameters: - in: "body" - name: "tapi.connectivity.ConnectivityService.body-param" - description: "tapi.connectivity.ConnectivityService to be added to list" + name: "tapi.connectivity.connectivitycontext.ConnectivityService.body-param" + description: "tapi.connectivity.connectivitycontext.ConnectivityService to\ + \ be added to list" required: false schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityService" + $ref: "#/definitions/tapi.connectivity.connectivitycontext.ConnectivityService" responses: 201: description: "Object created" @@ -631,7 +795,8 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityService" + summary: "returns tapi.connectivity.connectivitycontext.ConnectivityService" + description: "none" parameters: - name: "uuid" in: "path" @@ -640,38 +805,16 @@ paths: type: "string" responses: 200: - description: "tapi.connectivity.ConnectivityService" + description: "tapi.connectivity.connectivitycontext.ConnectivityService" schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityService" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityService" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.connectivity.ConnectivityService.body-param" - description: "tapi.connectivity.ConnectivityService to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityService" - responses: - 201: - description: "Object created" + $ref: "#/definitions/tapi.connectivity.connectivitycontext.ConnectivityService" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityService" + summary: "creates or updates tapi.connectivity.connectivitycontext.ConnectivityService" + description: "none" parameters: - name: "uuid" in: "path" @@ -679,11 +822,12 @@ paths: required: true type: "string" - in: "body" - name: "tapi.connectivity.ConnectivityService.body-param" - description: "tapi.connectivity.ConnectivityService to be added or updated" + name: "tapi.connectivity.connectivitycontext.ConnectivityService.body-param" + description: "tapi.connectivity.connectivitycontext.ConnectivityService to\ + \ be added or updated" required: false schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityService" + $ref: "#/definitions/tapi.connectivity.connectivitycontext.ConnectivityService" responses: 201: description: "Object created" @@ -694,7 +838,8 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityService" + summary: "removes tapi.connectivity.connectivitycontext.ConnectivityService" + description: "none" parameters: - name: "uuid" in: "path" @@ -706,34 +851,12 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/avoid-topology={topology-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of avoid-topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" /data/context/connectivity-context/connectivity-service={uuid}/connection={connection-uuid}/: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionRef" + summary: "returns tapi.connectivity.ConnectionRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -752,11 +875,12 @@ paths: $ref: "#/definitions/tapi.connectivity.ConnectionRef" 400: description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/coroute-inclusion/: + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityServiceRef" + summary: "returns tapi.connectivity.ConnectivityConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -765,15 +889,16 @@ paths: type: "string" responses: 200: - description: "tapi.connectivity.ConnectivityServiceRef" + description: "tapi.connectivity.ConnectivityConstraint" schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" 400: description: "Internal error" post: tags: - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceRef" + summary: "creates tapi.connectivity.ConnectivityConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -781,11 +906,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.connectivity.ConnectivityServiceRef.body-param" - description: "tapi.connectivity.ConnectivityServiceRef to be added to list" + name: "tapi.connectivity.ConnectivityConstraint.body-param" + description: "tapi.connectivity.ConnectivityConstraint to be added to list" required: false schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" responses: 201: description: "Object created" @@ -796,7 +921,8 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityServiceRef" + summary: "creates or updates tapi.connectivity.ConnectivityConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -804,11 +930,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.connectivity.ConnectivityServiceRef.body-param" - description: "tapi.connectivity.ConnectivityServiceRef to be added or updated" + name: "tapi.connectivity.ConnectivityConstraint.body-param" + description: "tapi.connectivity.ConnectivityConstraint to be added or updated" required: false schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" responses: 201: description: "Object created" @@ -819,7 +945,8 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityServiceRef" + summary: "removes tapi.connectivity.ConnectivityConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -831,74 +958,42 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/cost-characteristic/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/cost-characteristic={cost-name}/: + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/coroute-inclusion/: get: tags: - "tapi-connectivity" - description: "returns tapi.topology.CostCharacteristic" + summary: "returns tapi.connectivity.ConnectivityServiceRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" responses: 200: - description: "tapi.topology.CostCharacteristic" + description: "tapi.connectivity.ConnectivityServiceRef" schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" 400: description: "Internal error" post: tags: - "tapi-connectivity" - description: "creates tapi.topology.CostCharacteristic" + summary: "creates tapi.connectivity.ConnectivityServiceRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" + name: "tapi.connectivity.ConnectivityServiceRef.body-param" + description: "tapi.connectivity.ConnectivityServiceRef to be added to list" required: false schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" responses: 201: description: "Object created" @@ -909,24 +1004,20 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.topology.CostCharacteristic" + summary: "creates or updates tapi.connectivity.ConnectivityServiceRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added or updated" + name: "tapi.connectivity.ConnectivityServiceRef.body-param" + description: "tapi.connectivity.ConnectivityServiceRef to be added or updated" required: false schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" responses: 201: description: "Object created" @@ -937,28 +1028,25 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.topology.CostCharacteristic" + summary: "removes tapi.connectivity.ConnectivityServiceRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/diversity-exclusion/: + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/diversity-exclusion/: post: tags: - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceRef" + summary: "creates tapi.connectivity.ConnectivityServiceRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -978,11 +1066,12 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/diversity-exclusion={connectivity-service-uuid}/: - get: + ? /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/diversity-exclusion={connectivity-service-uuid}/ + : get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityServiceRef" + summary: "returns tapi.connectivity.ConnectivityServiceRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1001,38 +1090,11 @@ paths: $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" 400: description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "connectivity-service-uuid" - in: "path" - description: "Id of diversity-exclusion" - required: true - type: "string" - - in: "body" - name: "tapi.connectivity.ConnectivityServiceRef.body-param" - description: "tapi.connectivity.ConnectivityServiceRef to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityServiceRef" + summary: "creates or updates tapi.connectivity.ConnectivityServiceRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1060,7 +1122,8 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityServiceRef" + summary: "removes tapi.connectivity.ConnectivityServiceRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1077,76 +1140,42 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.connectivity.ConnectivityServiceEndPoint.body-param" - description: "tapi.connectivity.ConnectivityServiceEndPoint to be added to\ - \ list" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/: + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/requested-capacity/: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityServiceEndPoint" + summary: "returns tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" responses: 200: - description: "tapi.connectivity.ConnectivityServiceEndPoint" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" post: tags: - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceEndPoint" + summary: "creates tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - in: "body" - name: "tapi.connectivity.ConnectivityServiceEndPoint.body-param" - description: "tapi.connectivity.ConnectivityServiceEndPoint to be added to\ - \ list" + name: "tapi.common.Capacity.body-param" + description: "tapi.common.Capacity to be added to list" required: false schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" + $ref: "#/definitions/tapi.common.Capacity" responses: 201: description: "Object created" @@ -1157,25 +1186,20 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityServiceEndPoint" + summary: "creates or updates tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - in: "body" - name: "tapi.connectivity.ConnectivityServiceEndPoint.body-param" - description: "tapi.connectivity.ConnectivityServiceEndPoint to be added or\ - \ updated" + name: "tapi.common.Capacity.body-param" + description: "tapi.common.Capacity to be added or updated" required: false schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" + $ref: "#/definitions/tapi.common.Capacity" responses: 201: description: "Object created" @@ -1186,67 +1210,57 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityServiceEndPoint" + summary: "removes tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/: + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/requested-capacity/total-size/: get: tags: - "tapi-connectivity" - description: "returns tapi.common.Capacity" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" responses: 200: - description: "tapi.common.Capacity" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" post: tags: - "tapi-connectivity" - description: "creates tapi.common.Capacity" + summary: "creates tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - in: "body" - name: "tapi.common.Capacity.body-param" - description: "tapi.common.Capacity to be added to list" + name: "tapi.common.CapacityValue.body-param" + description: "tapi.common.CapacityValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.common.CapacityValue" responses: 201: description: "Object created" @@ -1257,24 +1271,21 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.Capacity" + summary: "creates or updates tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - in: "body" - name: "tapi.common.Capacity.body-param" - description: "tapi.common.Capacity to be added or updated" + name: "tapi.common.CapacityValue.body-param" + description: "tapi.common.CapacityValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.common.CapacityValue" responses: 201: description: "Object created" @@ -1285,67 +1296,56 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.Capacity" + summary: "removes tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/: + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/schedule/: get: tags: - "tapi-connectivity" - description: "returns tapi.common.BandwidthProfile" + summary: "returns tapi.common.TimeRange" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.common.TimeRange" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.common.TimeRange" 400: description: "Internal error" post: tags: - "tapi-connectivity" - description: "creates tapi.common.BandwidthProfile" + summary: "creates tapi.common.TimeRange" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - in: "body" - name: "tapi.common.BandwidthProfile.body-param" - description: "tapi.common.BandwidthProfile to be added to list" + name: "tapi.common.TimeRange.body-param" + description: "tapi.common.TimeRange to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.common.TimeRange" responses: 201: description: "Object created" @@ -1356,24 +1356,20 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.BandwidthProfile" + summary: "creates or updates tapi.common.TimeRange" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - in: "body" - name: "tapi.common.BandwidthProfile.body-param" - description: "tapi.common.BandwidthProfile to be added or updated" + name: "tapi.common.TimeRange.body-param" + description: "tapi.common.TimeRange to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.common.TimeRange" responses: 201: description: "Object created" @@ -1384,50 +1380,51 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.BandwidthProfile" + summary: "removes tapi.common.TimeRange" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-burst-size/ - : get: + /data/context/connectivity-context/connectivity-service={uuid}/end-point/: + post: tags: - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" + summary: "creates tapi.connectivity.connectivityservice.EndPoint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" + - in: "body" + name: "tapi.connectivity.connectivityservice.EndPoint.body-param" + description: "tapi.connectivity.connectivityservice.EndPoint to be added to\ + \ list" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/: + get: tags: - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + summary: "returns tapi.connectivity.connectivityservice.EndPoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -1439,23 +1436,18 @@ paths: description: "Id of end-point" required: true type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.connectivity.connectivityservice.EndPoint" + schema: + $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.connectivity.connectivityservice.EndPoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -1468,11 +1460,12 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.connectivity.connectivityservice.EndPoint.body-param" + description: "tapi.connectivity.connectivityservice.EndPoint to be added or\ + \ updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" responses: 201: description: "Object created" @@ -1483,7 +1476,8 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.connectivity.connectivityservice.EndPoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -1500,11 +1494,12 @@ paths: description: "Internal error" 204: description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-information-rate/ - : get: + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/: + get: tags: - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" @@ -1518,15 +1513,16 @@ paths: type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" post: tags: - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + summary: "creates tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" @@ -1539,11 +1535,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.common.Capacity.body-param" + description: "tapi.common.Capacity to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" responses: 201: description: "Object created" @@ -1554,7 +1550,8 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" @@ -1567,11 +1564,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.common.Capacity.body-param" + description: "tapi.common.Capacity to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" responses: 201: description: "Object created" @@ -1582,7 +1579,8 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" @@ -1599,11 +1597,13 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-burst-size/: + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/total-size/: get: tags: - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -1625,7 +1625,9 @@ paths: post: tags: - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + summary: "creates tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -1653,7 +1655,9 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -1681,7 +1685,9 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -1698,11 +1704,56 @@ paths: description: "Internal error" 204: description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-information-rate/ + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/connection-end-point={topology-uuid},{node-uuid},{node-edge-point-uuid},{connection-end-point-uuid}/ : get: tags: - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.connectivity.ConnectionEndPointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.connectivity.ConnectionEndPointRef" + schema: + $ref: "#/definitions/tapi.connectivity.ConnectionEndPointRef" + 400: + description: "Internal error" + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/eth-connectivity-service-end-point-spec/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthConnectivityServiceEndPointSpec" + description: "none" parameters: - name: "uuid" in: "path" @@ -1716,15 +1767,16 @@ paths: type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.eth.EthConnectivityServiceEndPointSpec" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.eth.EthConnectivityServiceEndPointSpec" 400: description: "Internal error" post: tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + - "tapi-eth" + summary: "creates tapi.eth.EthConnectivityServiceEndPointSpec" + description: "none" parameters: - name: "uuid" in: "path" @@ -1737,11 +1789,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.eth.EthConnectivityServiceEndPointSpec.body-param" + description: "tapi.eth.EthConnectivityServiceEndPointSpec to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.eth.EthConnectivityServiceEndPointSpec" responses: 201: description: "Object created" @@ -1751,8 +1803,9 @@ paths: description: "Object already exists" put: tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + - "tapi-eth" + summary: "creates or updates tapi.eth.EthConnectivityServiceEndPointSpec" + description: "none" parameters: - name: "uuid" in: "path" @@ -1765,11 +1818,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.eth.EthConnectivityServiceEndPointSpec.body-param" + description: "tapi.eth.EthConnectivityServiceEndPointSpec to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.eth.EthConnectivityServiceEndPointSpec" responses: 201: description: "Object created" @@ -1779,8 +1832,9 @@ paths: description: "Object modified" delete: tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + - "tapi-eth" + summary: "removes tapi.eth.EthConnectivityServiceEndPointSpec" + description: "none" parameters: - name: "uuid" in: "path" @@ -1797,11 +1851,12 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/total-size/: - get: + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/eth-connectivity-service-end-point-spec/eth-ctp-common-pac/ + : get: tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" + - "tapi-eth" + summary: "returns tapi.eth.EthCtpCommonPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -1815,15 +1870,16 @@ paths: type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.eth.EthCtpCommonPac" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.eth.EthCtpCommonPac" 400: description: "Internal error" post: tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + - "tapi-eth" + summary: "creates tapi.eth.EthCtpCommonPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -1836,11 +1892,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.eth.EthCtpCommonPac.body-param" + description: "tapi.eth.EthCtpCommonPac to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.eth.EthCtpCommonPac" responses: 201: description: "Object created" @@ -1850,8 +1906,9 @@ paths: description: "Object already exists" put: tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + - "tapi-eth" + summary: "creates or updates tapi.eth.EthCtpCommonPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -1864,11 +1921,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.eth.EthCtpCommonPac.body-param" + description: "tapi.eth.EthCtpCommonPac to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.eth.EthCtpCommonPac" responses: 201: description: "Object created" @@ -1878,8 +1935,9 @@ paths: description: "Object modified" delete: tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + - "tapi-eth" + summary: "removes tapi.eth.EthCtpCommonPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -1896,11 +1954,21 @@ paths: description: "Internal error" 204: description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/connection-end-point={topology-uuid},{node-uuid},{node-edge-point-uuid},{connection-end-point-uuid}/ + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/eth-connectivity-service-end-point-spec/eth-ctp-common-pac/filter-config/ : get: tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionEndPointRef" + - "tapi-eth" + summary: "returns tapi.eth.ControlFrameFilter" + description: "This attribute models the FilterConfig MI defined in section 8.3/G.8021.\ + \ It indicates the configured filter action for each of the 33 group MAC addresses\ + \ for control frames. The 33 MAC addresses are:\r\n - All bridges\ + \ address: 01-80-C2-00-00-10,\r\n - Reserved addresses: 01-80-C2-00-00-00\ + \ to 01-80-C2-00-00-0F,\r\n - GARP Application addresses: 01-80-C2-00-00-20\ + \ to 01-80-C2-00-00-2F.\r\n The filter action is Pass or Block.\ + \ \r\n If the destination address of the incoming ETH_CI_D\ + \ matches one of the above addresses, the filter process shall perform the\ + \ corresponding configured filter action. \r\n If none of the\ + \ above addresses match, the ETH_CI_D is passed." parameters: - name: "uuid" in: "path" @@ -1912,38 +1980,27 @@ paths: description: "Id of end-point" required: true type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" responses: 200: - description: "tapi.connectivity.ConnectionEndPointRef" + description: "tapi.eth.ControlFrameFilter" schema: - $ref: "#/definitions/tapi.connectivity.ConnectionEndPointRef" + $ref: "#/definitions/tapi.eth.ControlFrameFilter" 400: description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/name/: post: tags: - - "tapi-connectivity" - description: "creates tapi.common.NameAndValue" + - "tapi-eth" + summary: "creates tapi.eth.ControlFrameFilter" + description: "This attribute models the FilterConfig MI defined in section 8.3/G.8021.\ + \ It indicates the configured filter action for each of the 33 group MAC addresses\ + \ for control frames. The 33 MAC addresses are:\r\n - All bridges\ + \ address: 01-80-C2-00-00-10,\r\n - Reserved addresses: 01-80-C2-00-00-00\ + \ to 01-80-C2-00-00-0F,\r\n - GARP Application addresses: 01-80-C2-00-00-20\ + \ to 01-80-C2-00-00-2F.\r\n The filter action is Pass or Block.\ + \ \r\n If the destination address of the incoming ETH_CI_D\ + \ matches one of the above addresses, the filter process shall perform the\ + \ corresponding configured filter action. \r\n If none of the\ + \ above addresses match, the ETH_CI_D is passed." parameters: - name: "uuid" in: "path" @@ -1956,11 +2013,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.eth.ControlFrameFilter.body-param" + description: "tapi.eth.ControlFrameFilter to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.eth.ControlFrameFilter" responses: 201: description: "Object created" @@ -1968,11 +2025,20 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/name={value-name}/: - get: + put: tags: - - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" + - "tapi-eth" + summary: "creates or updates tapi.eth.ControlFrameFilter" + description: "This attribute models the FilterConfig MI defined in section 8.3/G.8021.\ + \ It indicates the configured filter action for each of the 33 group MAC addresses\ + \ for control frames. The 33 MAC addresses are:\r\n - All bridges\ + \ address: 01-80-C2-00-00-10,\r\n - Reserved addresses: 01-80-C2-00-00-00\ + \ to 01-80-C2-00-00-0F,\r\n - GARP Application addresses: 01-80-C2-00-00-20\ + \ to 01-80-C2-00-00-2F.\r\n The filter action is Pass or Block.\ + \ \r\n If the destination address of the incoming ETH_CI_D\ + \ matches one of the above addresses, the filter process shall perform the\ + \ corresponding configured filter action. \r\n If none of the\ + \ above addresses match, the ETH_CI_D is passed." parameters: - name: "uuid" in: "path" @@ -1984,22 +2050,55 @@ paths: description: "Id of end-point" required: true type: "string" - - name: "value-name" + - in: "body" + name: "tapi.eth.ControlFrameFilter.body-param" + description: "tapi.eth.ControlFrameFilter to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.eth.ControlFrameFilter" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-eth" + summary: "removes tapi.eth.ControlFrameFilter" + description: "This attribute models the FilterConfig MI defined in section 8.3/G.8021.\ + \ It indicates the configured filter action for each of the 33 group MAC addresses\ + \ for control frames. The 33 MAC addresses are:\r\n - All bridges\ + \ address: 01-80-C2-00-00-10,\r\n - Reserved addresses: 01-80-C2-00-00-00\ + \ to 01-80-C2-00-00-0F,\r\n - GARP Application addresses: 01-80-C2-00-00-20\ + \ to 01-80-C2-00-00-2F.\r\n The filter action is Pass or Block.\ + \ \r\n If the destination address of the incoming ETH_CI_D\ + \ matches one of the above addresses, the filter process shall perform the\ + \ corresponding configured filter action. \r\n If none of the\ + \ above addresses match, the ETH_CI_D is passed." + parameters: + - name: "uuid" in: "path" - description: "Id of name" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" required: true type: "string" responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: + 204: + description: "Object deleted" + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/eth-connectivity-service-end-point-spec/eth-ctp-common-pac/traffic-conditioning-pac/ + : get: tags: - - "tapi-connectivity" - description: "creates tapi.common.NameAndValue" + - "tapi-eth" + summary: "returns tapi.eth.TrafficConditioningPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -2011,17 +2110,35 @@ paths: description: "Id of end-point" required: true type: "string" - - name: "value-name" + responses: + 200: + description: "tapi.eth.TrafficConditioningPac" + schema: + $ref: "#/definitions/tapi.eth.TrafficConditioningPac" + 400: + description: "Internal error" + post: + tags: + - "tapi-eth" + summary: "creates tapi.eth.TrafficConditioningPac" + description: "none" + parameters: + - name: "uuid" in: "path" - description: "Id of name" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.eth.TrafficConditioningPac.body-param" + description: "tapi.eth.TrafficConditioningPac to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.eth.TrafficConditioningPac" responses: 201: description: "Object created" @@ -2031,8 +2148,9 @@ paths: description: "Object already exists" put: tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.NameAndValue" + - "tapi-eth" + summary: "creates or updates tapi.eth.TrafficConditioningPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -2044,17 +2162,12 @@ paths: description: "Id of end-point" required: true type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" + name: "tapi.eth.TrafficConditioningPac.body-param" + description: "tapi.eth.TrafficConditioningPac to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.eth.TrafficConditioningPac" responses: 201: description: "Object created" @@ -2064,8 +2177,9 @@ paths: description: "Object modified" delete: tags: - - "tapi-connectivity" - description: "removes tapi.common.NameAndValue" + - "tapi-eth" + summary: "removes tapi.eth.TrafficConditioningPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -2077,21 +2191,24 @@ paths: description: "Id of end-point" required: true type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/service-interface-point/: - get: + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/eth-connectivity-service-end-point-spec/eth-ctp-common-pac/traffic-conditioning-pac/cond-config-list/ + : post: tags: - - "tapi-connectivity" - description: "returns tapi.common.ServiceInterfacePointRef" + - "tapi-eth" + summary: "creates tapi.eth.TrafficConditioningConfiguration" + description: "This attribute indicates for the conditioner process the conditioning\ + \ parameters:\r\n - Queue ID: Indicates the Queue ID\r\n \ + \ - Committed Information Rate (CIR): number of bits per second\r\ + \n - Committed Burst Size (CBS): number of bytes\r\n \ + \ - Excess Information Rate (EIR): number of bits per second\r\n\ + \ - Excess Burst Size (EBS): number of bytes\r\n \ + \ - Coupling flag (CF): 0 or 1\r\n - Color mode (CM):\ + \ color-blind and color-aware." parameters: - name: "uuid" in: "path" @@ -2103,17 +2220,32 @@ paths: description: "Id of end-point" required: true type: "string" + - in: "body" + name: "tapi.eth.TrafficConditioningConfiguration.body-param" + description: "tapi.eth.TrafficConditioningConfiguration to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.eth.TrafficConditioningConfiguration" responses: - 200: - description: "tapi.common.ServiceInterfacePointRef" - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/eth-connectivity-service-end-point-spec/eth-ctp-common-pac/traffic-conditioning-pac/cond-config-list={queue-id}/ + : get: tags: - - "tapi-connectivity" - description: "creates tapi.common.ServiceInterfacePointRef" + - "tapi-eth" + summary: "returns tapi.eth.TrafficConditioningConfiguration" + description: "This attribute indicates for the conditioner process the conditioning\ + \ parameters:\r\n - Queue ID: Indicates the Queue ID\r\n \ + \ - Committed Information Rate (CIR): number of bits per second\r\ + \n - Committed Burst Size (CBS): number of bytes\r\n \ + \ - Excess Information Rate (EIR): number of bits per second\r\n\ + \ - Excess Burst Size (EBS): number of bytes\r\n \ + \ - Coupling flag (CF): 0 or 1\r\n - Color mode (CM):\ + \ color-blind and color-aware." parameters: - name: "uuid" in: "path" @@ -2125,23 +2257,31 @@ paths: description: "Id of end-point" required: true type: "string" - - in: "body" - name: "tapi.common.ServiceInterfacePointRef.body-param" - description: "tapi.common.ServiceInterfacePointRef to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + - name: "queue-id" + in: "path" + description: "Id of cond-config-list" + required: true + type: "integer" + format: "int32" responses: - 201: - description: "Object created" + 200: + description: "tapi.eth.TrafficConditioningConfiguration" + schema: + $ref: "#/definitions/tapi.eth.TrafficConditioningConfiguration" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.ServiceInterfacePointRef" + - "tapi-eth" + summary: "creates or updates tapi.eth.TrafficConditioningConfiguration" + description: "This attribute indicates for the conditioner process the conditioning\ + \ parameters:\r\n - Queue ID: Indicates the Queue ID\r\n \ + \ - Committed Information Rate (CIR): number of bits per second\r\ + \n - Committed Burst Size (CBS): number of bytes\r\n \ + \ - Excess Information Rate (EIR): number of bits per second\r\n\ + \ - Excess Burst Size (EBS): number of bytes\r\n \ + \ - Coupling flag (CF): 0 or 1\r\n - Color mode (CM):\ + \ color-blind and color-aware." parameters: - name: "uuid" in: "path" @@ -2153,12 +2293,18 @@ paths: description: "Id of end-point" required: true type: "string" + - name: "queue-id" + in: "path" + description: "Id of cond-config-list" + required: true + type: "integer" + format: "int32" - in: "body" - name: "tapi.common.ServiceInterfacePointRef.body-param" - description: "tapi.common.ServiceInterfacePointRef to be added or updated" + name: "tapi.eth.TrafficConditioningConfiguration.body-param" + description: "tapi.eth.TrafficConditioningConfiguration to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + $ref: "#/definitions/tapi.eth.TrafficConditioningConfiguration" responses: 201: description: "Object created" @@ -2168,8 +2314,16 @@ paths: description: "Object modified" delete: tags: - - "tapi-connectivity" - description: "removes tapi.common.ServiceInterfacePointRef" + - "tapi-eth" + summary: "removes tapi.eth.TrafficConditioningConfiguration" + description: "This attribute indicates for the conditioner process the conditioning\ + \ parameters:\r\n - Queue ID: Indicates the Queue ID\r\n \ + \ - Committed Information Rate (CIR): number of bits per second\r\ + \n - Committed Burst Size (CBS): number of bytes\r\n \ + \ - Excess Information Rate (EIR): number of bits per second\r\n\ + \ - Excess Burst Size (EBS): number of bytes\r\n \ + \ - Coupling flag (CF): 0 or 1\r\n - Color mode (CM):\ + \ color-blind and color-aware." parameters: - name: "uuid" in: "path" @@ -2181,260 +2335,270 @@ paths: description: "Id of end-point" required: true type: "string" + - name: "queue-id" + in: "path" + description: "Id of cond-config-list" + required: true + type: "integer" + format: "int32" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/exclude-link={topology-uuid},{link-uuid}/: - get: + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/eth-connectivity-service-end-point-spec/eth-ctp-common-pac/traffic-conditioning-pac/prio-config-list/ + : post: tags: - - "tapi-connectivity" - description: "returns tapi.topology.LinkRef" + - "tapi-eth" + summary: "creates tapi.eth.PriorityConfiguration" + description: "This attribute indicates the Priority Splitter function for the\ + \ mapping of the Ethernet frame priority (ETH_CI_P) values to the output queue." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of exclude-link" - required: true - type: "string" - - name: "link-uuid" + - name: "local-id" in: "path" - description: "Id of exclude-link" + description: "Id of end-point" required: true type: "string" + - in: "body" + name: "tapi.eth.PriorityConfiguration.body-param" + description: "tapi.eth.PriorityConfiguration to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.eth.PriorityConfiguration" responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/exclude-node={topology-uuid},{node-uuid}/: - get: + 409: + description: "Object already exists" + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/eth-connectivity-service-end-point-spec/eth-ctp-common-pac/traffic-conditioning-pac/prio-config-list={queue-id}/ + : get: tags: - - "tapi-connectivity" - description: "returns tapi.topology.NodeRef" + - "tapi-eth" + summary: "returns tapi.eth.PriorityConfiguration" + description: "This attribute indicates the Priority Splitter function for the\ + \ mapping of the Ethernet frame priority (ETH_CI_P) values to the output queue." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "topology-uuid" + - name: "local-id" in: "path" - description: "Id of exclude-node" + description: "Id of end-point" required: true type: "string" - - name: "node-uuid" + - name: "queue-id" in: "path" - description: "Id of exclude-node" + description: "Id of prio-config-list" required: true - type: "string" + type: "integer" + format: "int32" responses: 200: - description: "tapi.topology.NodeRef" + description: "tapi.eth.PriorityConfiguration" schema: - $ref: "#/definitions/tapi.topology.NodeRef" + $ref: "#/definitions/tapi.eth.PriorityConfiguration" 400: description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/exclude-path={path-uuid}/: - get: + put: tags: - - "tapi-connectivity" - description: "returns tapi.path.computation.PathRef" + - "tapi-eth" + summary: "creates or updates tapi.eth.PriorityConfiguration" + description: "This attribute indicates the Priority Splitter function for the\ + \ mapping of the Ethernet frame priority (ETH_CI_P) values to the output queue." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "path-uuid" + - name: "local-id" in: "path" - description: "Id of exclude-path" + description: "Id of end-point" required: true type: "string" + - name: "queue-id" + in: "path" + description: "Id of prio-config-list" + required: true + type: "integer" + format: "int32" + - in: "body" + name: "tapi.eth.PriorityConfiguration.body-param" + description: "tapi.eth.PriorityConfiguration to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.eth.PriorityConfiguration" responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/include-link={topology-uuid},{link-uuid}/: - get: + 204: + description: "Object modified" + delete: tags: - - "tapi-connectivity" - description: "returns tapi.topology.LinkRef" + - "tapi-eth" + summary: "removes tapi.eth.PriorityConfiguration" + description: "This attribute indicates the Priority Splitter function for the\ + \ mapping of the Ethernet frame priority (ETH_CI_P) values to the output queue." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "topology-uuid" + - name: "local-id" in: "path" - description: "Id of include-link" + description: "Id of end-point" required: true type: "string" - - name: "link-uuid" + - name: "queue-id" in: "path" - description: "Id of include-link" + description: "Id of prio-config-list" required: true - type: "string" + type: "integer" + format: "int32" responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" 400: description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/include-node={topology-uuid},{node-uuid}/: - get: + 204: + description: "Object deleted" + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/eth-connectivity-service-end-point-spec/eth-ctp-common-pac/traffic-shaping-pac/ + : get: tags: - - "tapi-connectivity" - description: "returns tapi.topology.NodeRef" + - "tapi-eth" + summary: "returns tapi.eth.TrafficShapingPac" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-node" - required: true - type: "string" - - name: "node-uuid" + - name: "local-id" in: "path" - description: "Id of include-node" + description: "Id of end-point" required: true type: "string" responses: 200: - description: "tapi.topology.NodeRef" + description: "tapi.eth.TrafficShapingPac" schema: - $ref: "#/definitions/tapi.topology.NodeRef" + $ref: "#/definitions/tapi.eth.TrafficShapingPac" 400: description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/include-path={path-uuid}/: - get: + post: tags: - - "tapi-connectivity" - description: "returns tapi.path.computation.PathRef" + - "tapi-eth" + summary: "creates tapi.eth.TrafficShapingPac" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "path-uuid" + - name: "local-id" in: "path" - description: "Id of include-path" + description: "Id of end-point" required: true type: "string" + - in: "body" + name: "tapi.eth.TrafficShapingPac.body-param" + description: "tapi.eth.TrafficShapingPac to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.eth.TrafficShapingPac" responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/include-topology={topology-uuid}/: - get: + 409: + description: "Object already exists" + put: tags: - - "tapi-connectivity" - description: "returns tapi.topology.TopologyRef" + - "tapi-eth" + summary: "creates or updates tapi.eth.TrafficShapingPac" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/latency-characteristic/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" + - name: "local-id" in: "path" - description: "Id of connectivity-service" + description: "Id of end-point" required: true type: "string" - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" + name: "tapi.eth.TrafficShapingPac.body-param" + description: "tapi.eth.TrafficShapingPac to be added or updated" required: false schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + $ref: "#/definitions/tapi.eth.TrafficShapingPac" responses: 201: description: "Object created" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/latency-characteristic={traffic-property-name}/: - get: + 204: + description: "Object modified" + delete: tags: - - "tapi-connectivity" - description: "returns tapi.topology.LatencyCharacteristic" + - "tapi-eth" + summary: "removes tapi.eth.TrafficShapingPac" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "traffic-property-name" + - name: "local-id" in: "path" - description: "Id of latency-characteristic" + description: "Id of end-point" required: true type: "string" responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" - post: + 204: + description: "Object deleted" + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/eth-connectivity-service-end-point-spec/eth-ctp-common-pac/traffic-shaping-pac/prio-config-list/ + : post: tags: - - "tapi-connectivity" - description: "creates tapi.topology.LatencyCharacteristic" + - "tapi-eth" + summary: "creates tapi.eth.PriorityConfiguration" + description: "This attribute configures the Priority Splitter function for the\ + \ mapping of the Ethernet frame priority (ETH_CI_P) values to the output queue." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "traffic-property-name" + - name: "local-id" in: "path" - description: "Id of latency-characteristic" + description: "Id of end-point" required: true type: "string" - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" + name: "tapi.eth.PriorityConfiguration.body-param" + description: "tapi.eth.PriorityConfiguration to be added to list" required: false schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + $ref: "#/definitions/tapi.eth.PriorityConfiguration" responses: 201: description: "Object created" @@ -2442,27 +2606,66 @@ paths: description: "Internal error" 409: description: "Object already exists" + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/eth-connectivity-service-end-point-spec/eth-ctp-common-pac/traffic-shaping-pac/prio-config-list={queue-id}/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.PriorityConfiguration" + description: "This attribute configures the Priority Splitter function for the\ + \ mapping of the Ethernet frame priority (ETH_CI_P) values to the output queue." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "queue-id" + in: "path" + description: "Id of prio-config-list" + required: true + type: "integer" + format: "int32" + responses: + 200: + description: "tapi.eth.PriorityConfiguration" + schema: + $ref: "#/definitions/tapi.eth.PriorityConfiguration" + 400: + description: "Internal error" put: tags: - - "tapi-connectivity" - description: "creates or updates tapi.topology.LatencyCharacteristic" + - "tapi-eth" + summary: "creates or updates tapi.eth.PriorityConfiguration" + description: "This attribute configures the Priority Splitter function for the\ + \ mapping of the Ethernet frame priority (ETH_CI_P) values to the output queue." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "traffic-property-name" + - name: "local-id" in: "path" - description: "Id of latency-characteristic" + description: "Id of end-point" required: true type: "string" + - name: "queue-id" + in: "path" + description: "Id of prio-config-list" + required: true + type: "integer" + format: "int32" - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added or updated" + name: "tapi.eth.PriorityConfiguration.body-param" + description: "tapi.eth.PriorityConfiguration to be added or updated" required: false schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + $ref: "#/definitions/tapi.eth.PriorityConfiguration" responses: 201: description: "Object created" @@ -2472,41 +2675,61 @@ paths: description: "Object modified" delete: tags: - - "tapi-connectivity" - description: "removes tapi.topology.LatencyCharacteristic" + - "tapi-eth" + summary: "removes tapi.eth.PriorityConfiguration" + description: "This attribute configures the Priority Splitter function for the\ + \ mapping of the Ethernet frame priority (ETH_CI_P) values to the output queue." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "traffic-property-name" + - name: "local-id" in: "path" - description: "Id of latency-characteristic" + description: "Id of end-point" required: true type: "string" + - name: "queue-id" + in: "path" + description: "Id of prio-config-list" + required: true + type: "integer" + format: "int32" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/name/: - post: + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/eth-connectivity-service-end-point-spec/eth-ctp-common-pac/traffic-shaping-pac/queue-config-list/ + : post: tags: - - "tapi-connectivity" - description: "creates tapi.common.NameAndValue" + - "tapi-eth" + summary: "creates tapi.eth.QueueConfiguration" + description: "This attribute configures the Queue depth and Dropping threshold\ + \ parameters of the Queue process. The Queue depth sets the maximum size of\ + \ the queue in bytes. An incoming ETH_CI traffic unit is dropped if there\ + \ is insufficient space in the queue to hold the whole unit. The Dropping\ + \ threshold sets the threshold of the queue. If the queue is filled beyond\ + \ this threshold, incoming ETH_CI traffic units accompanied by the ETH_CI_DE\ + \ signal set are dropped." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.eth.QueueConfiguration.body-param" + description: "tapi.eth.QueueConfiguration to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.eth.QueueConfiguration" responses: 201: description: "Object created" @@ -2514,78 +2737,76 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/name={value-name}/: - get: + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/eth-connectivity-service-end-point-spec/eth-ctp-common-pac/traffic-shaping-pac/queue-config-list={queue-id}/ + : get: tags: - - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" + - "tapi-eth" + summary: "returns tapi.eth.QueueConfiguration" + description: "This attribute configures the Queue depth and Dropping threshold\ + \ parameters of the Queue process. The Queue depth sets the maximum size of\ + \ the queue in bytes. An incoming ETH_CI traffic unit is dropped if there\ + \ is insufficient space in the queue to hold the whole unit. The Dropping\ + \ threshold sets the threshold of the queue. If the queue is filled beyond\ + \ this threshold, incoming ETH_CI traffic units accompanied by the ETH_CI_DE\ + \ signal set are dropped." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of name" + description: "Id of end-point" required: true type: "string" + - name: "queue-id" + in: "path" + description: "Id of queue-config-list" + required: true + type: "integer" + format: "int32" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.eth.QueueConfiguration" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.eth.QueueConfiguration" 400: description: "Internal error" - post: + put: tags: - - "tapi-connectivity" - description: "creates tapi.common.NameAndValue" + - "tapi-eth" + summary: "creates or updates tapi.eth.QueueConfiguration" + description: "This attribute configures the Queue depth and Dropping threshold\ + \ parameters of the Queue process. The Queue depth sets the maximum size of\ + \ the queue in bytes. An incoming ETH_CI traffic unit is dropped if there\ + \ is insufficient space in the queue to hold the whole unit. The Dropping\ + \ threshold sets the threshold of the queue. If the queue is filled beyond\ + \ this threshold, incoming ETH_CI traffic units accompanied by the ETH_CI_DE\ + \ signal set are dropped." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" + - name: "local-id" in: "path" - description: "Id of connectivity-service" + description: "Id of end-point" required: true type: "string" - - name: "value-name" + - name: "queue-id" in: "path" - description: "Id of name" + description: "Id of queue-config-list" required: true - type: "string" + type: "integer" + format: "int32" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" + name: "tapi.eth.QueueConfiguration.body-param" + description: "tapi.eth.QueueConfiguration to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.eth.QueueConfiguration" responses: 201: description: "Object created" @@ -2595,58 +2816,83 @@ paths: description: "Object modified" delete: tags: - - "tapi-connectivity" - description: "removes tapi.common.NameAndValue" + - "tapi-eth" + summary: "removes tapi.eth.QueueConfiguration" + description: "This attribute configures the Queue depth and Dropping threshold\ + \ parameters of the Queue process. The Queue depth sets the maximum size of\ + \ the queue in bytes. An incoming ETH_CI traffic unit is dropped if there\ + \ is insufficient space in the queue to hold the whole unit. The Dropping\ + \ threshold sets the threshold of the queue. If the queue is filled beyond\ + \ this threshold, incoming ETH_CI traffic units accompanied by the ETH_CI_DE\ + \ signal set are dropped." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of name" + description: "Id of end-point" required: true type: "string" + - name: "queue-id" + in: "path" + description: "Id of queue-config-list" + required: true + type: "integer" + format: "int32" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/: - get: + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/eth-connectivity-service-end-point-spec/eth-termination-common-pac/ + : get: tags: - - "tapi-connectivity" - description: "returns tapi.common.Capacity" + - "tapi-eth" + summary: "returns tapi.eth.EthTerminationCommonPac" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" responses: 200: - description: "tapi.common.Capacity" + description: "tapi.eth.EthTerminationCommonPac" schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.eth.EthTerminationCommonPac" 400: description: "Internal error" post: tags: - - "tapi-connectivity" - description: "creates tapi.common.Capacity" + - "tapi-eth" + summary: "creates tapi.eth.EthTerminationCommonPac" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" - in: "body" - name: "tapi.common.Capacity.body-param" - description: "tapi.common.Capacity to be added to list" + name: "tapi.eth.EthTerminationCommonPac.body-param" + description: "tapi.eth.EthTerminationCommonPac to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.eth.EthTerminationCommonPac" responses: 201: description: "Object created" @@ -2656,20 +2902,26 @@ paths: description: "Object already exists" put: tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.Capacity" + - "tapi-eth" + summary: "creates or updates tapi.eth.EthTerminationCommonPac" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" - in: "body" - name: "tapi.common.Capacity.body-param" - description: "tapi.common.Capacity to be added or updated" + name: "tapi.eth.EthTerminationCommonPac.body-param" + description: "tapi.eth.EthTerminationCommonPac to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.eth.EthTerminationCommonPac" responses: 201: description: "Object created" @@ -2679,53 +2931,73 @@ paths: description: "Object modified" delete: tags: - - "tapi-connectivity" - description: "removes tapi.common.Capacity" + - "tapi-eth" + summary: "removes tapi.eth.EthTerminationCommonPac" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/: - get: + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/eth-connectivity-service-end-point-spec/eth-termination-common-pac/priority-regenerate/ + : get: tags: - - "tapi-connectivity" - description: "returns tapi.common.BandwidthProfile" + - "tapi-eth" + summary: "returns tapi.eth.PriorityMapping" + description: "This attribute models the ETHx/ETH-m _A_Sk_MI_P_Regenerate information\ + \ defined in G.8021." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.eth.PriorityMapping" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.eth.PriorityMapping" 400: description: "Internal error" post: tags: - - "tapi-connectivity" - description: "creates tapi.common.BandwidthProfile" + - "tapi-eth" + summary: "creates tapi.eth.PriorityMapping" + description: "This attribute models the ETHx/ETH-m _A_Sk_MI_P_Regenerate information\ + \ defined in G.8021." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" - in: "body" - name: "tapi.common.BandwidthProfile.body-param" - description: "tapi.common.BandwidthProfile to be added to list" + name: "tapi.eth.PriorityMapping.body-param" + description: "tapi.eth.PriorityMapping to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.eth.PriorityMapping" responses: 201: description: "Object created" @@ -2735,20 +3007,27 @@ paths: description: "Object already exists" put: tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.BandwidthProfile" + - "tapi-eth" + summary: "creates or updates tapi.eth.PriorityMapping" + description: "This attribute models the ETHx/ETH-m _A_Sk_MI_P_Regenerate information\ + \ defined in G.8021." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" - in: "body" - name: "tapi.common.BandwidthProfile.body-param" - description: "tapi.common.BandwidthProfile to be added or updated" + name: "tapi.eth.PriorityMapping.body-param" + description: "tapi.eth.PriorityMapping to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.eth.PriorityMapping" responses: 201: description: "Object created" @@ -2758,53 +3037,72 @@ paths: description: "Object modified" delete: tags: - - "tapi-connectivity" - description: "removes tapi.common.BandwidthProfile" + - "tapi-eth" + summary: "removes tapi.eth.PriorityMapping" + description: "This attribute models the ETHx/ETH-m _A_Sk_MI_P_Regenerate information\ + \ defined in G.8021." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/committed-burst-size/: - get: + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/eth-connectivity-service-end-point-spec/ety-termination-common-pac/ + : get: tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" + - "tapi-eth" + summary: "returns tapi.eth.EtyTerminationCommonPac" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.eth.EtyTerminationCommonPac" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.eth.EtyTerminationCommonPac" 400: description: "Internal error" post: tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + - "tapi-eth" + summary: "creates tapi.eth.EtyTerminationCommonPac" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.eth.EtyTerminationCommonPac.body-param" + description: "tapi.eth.EtyTerminationCommonPac to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.eth.EtyTerminationCommonPac" responses: 201: description: "Object created" @@ -2814,20 +3112,26 @@ paths: description: "Object already exists" put: tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + - "tapi-eth" + summary: "creates or updates tapi.eth.EtyTerminationCommonPac" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.eth.EtyTerminationCommonPac.body-param" + description: "tapi.eth.EtyTerminationCommonPac to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.eth.EtyTerminationCommonPac" responses: 201: description: "Object created" @@ -2837,76 +3141,117 @@ paths: description: "Object modified" delete: tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + - "tapi-eth" + summary: "removes tapi.eth.EtyTerminationCommonPac" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/committed-information-rate/: - get: + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/name/: + post: tags: - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/name={value-name}/: + get: tags: - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" responses: - 201: - description: "Object created" + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -2917,52 +3262,78 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/peak-burst-size/: + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/peer-fwd-connectivity-service-end-point/: get: tags: - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.connectivity.ConnectivityServiceEndPointRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" 400: description: "Internal error" post: tags: - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + summary: "creates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" responses: 201: description: "Object created" @@ -2973,19 +3344,26 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" responses: 201: description: "Object created" @@ -2996,52 +3374,71 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/peak-information-rate/: + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/protecting-connectivity-service-end-point/: get: tags: - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.connectivity.ConnectivityServiceEndPointRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" 400: description: "Internal error" post: tags: - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + summary: "creates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" responses: 201: description: "Object created" @@ -3052,19 +3449,26 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" responses: 201: description: "Object created" @@ -3075,52 +3479,71 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/total-size/: + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/server-connectivity-service-end-point/: get: tags: - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.connectivity.ConnectivityServiceEndPointRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" 400: description: "Internal error" post: tags: - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + summary: "creates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" responses: 201: description: "Object created" @@ -3131,19 +3554,26 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" responses: 201: description: "Object created" @@ -3154,52 +3584,70 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/resilience-type/: + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/service-interface-point/: get: tags: - "tapi-connectivity" - description: "returns tapi.topology.ResilienceType" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" responses: 200: - description: "tapi.topology.ResilienceType" + description: "tapi.common.ServiceInterfacePointRef" schema: - $ref: "#/definitions/tapi.topology.ResilienceType" + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" 400: description: "Internal error" post: tags: - "tapi-connectivity" - description: "creates tapi.topology.ResilienceType" + summary: "creates tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" - in: "body" - name: "tapi.topology.ResilienceType.body-param" - description: "tapi.topology.ResilienceType to be added to list" + name: "tapi.common.ServiceInterfacePointRef.body-param" + description: "tapi.common.ServiceInterfacePointRef to be added to list" required: false schema: - $ref: "#/definitions/tapi.topology.ResilienceType" + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" responses: 201: description: "Object created" @@ -3210,19 +3658,25 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.topology.ResilienceType" + summary: "creates or updates tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" - in: "body" - name: "tapi.topology.ResilienceType.body-param" - description: "tapi.topology.ResilienceType to be added or updated" + name: "tapi.common.ServiceInterfacePointRef.body-param" + description: "tapi.common.ServiceInterfacePointRef to be added or updated" required: false schema: - $ref: "#/definitions/tapi.topology.ResilienceType" + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" responses: 201: description: "Object created" @@ -3233,23 +3687,48 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.topology.ResilienceType" + summary: "removes tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/risk-diversity-characteristic/: + /data/context/connectivity-context/connectivity-service={uuid}/eth-connectivity-service/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthConnectivityService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthConnectivityService" + schema: + $ref: "#/definitions/tapi.eth.EthConnectivityService" + 400: + description: "Internal error" post: tags: - - "tapi-connectivity" - description: "creates tapi.topology.RiskCharacteristic" + - "tapi-eth" + summary: "creates tapi.eth.EthConnectivityService" + description: "none" parameters: - name: "uuid" in: "path" @@ -3257,11 +3736,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added to list" + name: "tapi.eth.EthConnectivityService.body-param" + description: "tapi.eth.EthConnectivityService to be added to list" required: false schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" + $ref: "#/definitions/tapi.eth.EthConnectivityService" responses: 201: description: "Object created" @@ -3269,50 +3748,66 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/risk-diversity-characteristic={risk-characteristic-name}/: - get: + put: tags: - - "tapi-connectivity" - description: "returns tapi.topology.RiskCharacteristic" + - "tapi-eth" + summary: "creates or updates tapi.eth.EthConnectivityService" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "risk-characteristic-name" + - in: "body" + name: "tapi.eth.EthConnectivityService.body-param" + description: "tapi.eth.EthConnectivityService to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthConnectivityService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-eth" + summary: "removes tapi.eth.EthConnectivityService" + description: "none" + parameters: + - name: "uuid" in: "path" - description: "Id of risk-diversity-characteristic" + description: "Id of connectivity-service" required: true type: "string" responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" 400: description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/name/: post: tags: - "tapi-connectivity" - description: "creates tapi.topology.RiskCharacteristic" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added to list" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -3320,27 +3815,56 @@ paths: description: "Internal error" 409: description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/name={value-name}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" put: tags: - "tapi-connectivity" - description: "creates or updates tapi.topology.RiskCharacteristic" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "risk-characteristic-name" + - name: "value-name" in: "path" - description: "Id of risk-diversity-characteristic" + description: "Id of name" required: true type: "string" - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added or updated" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -3351,16 +3875,19 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.topology.RiskCharacteristic" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "risk-characteristic-name" + - name: "value-name" in: "path" - description: "Id of risk-diversity-characteristic" + description: "Id of name" required: true type: "string" responses: @@ -3368,11 +3895,12 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/schedule/: + /data/context/connectivity-context/connectivity-service={uuid}/resilience-constraint/: get: tags: - "tapi-connectivity" - description: "returns tapi.common.TimeRange" + summary: "returns tapi.connectivity.ResilienceConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -3381,15 +3909,16 @@ paths: type: "string" responses: 200: - description: "tapi.common.TimeRange" + description: "tapi.connectivity.ResilienceConstraint" schema: - $ref: "#/definitions/tapi.common.TimeRange" + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" 400: description: "Internal error" post: tags: - "tapi-connectivity" - description: "creates tapi.common.TimeRange" + summary: "creates tapi.connectivity.ResilienceConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -3397,11 +3926,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.TimeRange.body-param" - description: "tapi.common.TimeRange to be added to list" + name: "tapi.connectivity.ResilienceConstraint.body-param" + description: "tapi.connectivity.ResilienceConstraint to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.TimeRange" + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" responses: 201: description: "Object created" @@ -3412,7 +3941,8 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.TimeRange" + summary: "creates or updates tapi.connectivity.ResilienceConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -3420,11 +3950,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.TimeRange.body-param" - description: "tapi.common.TimeRange to be added or updated" + name: "tapi.connectivity.ResilienceConstraint.body-param" + description: "tapi.connectivity.ResilienceConstraint to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.TimeRange" + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" responses: 201: description: "Object created" @@ -3435,7 +3965,8 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.TimeRange" + summary: "removes tapi.connectivity.ResilienceConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -3447,59 +3978,42 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/name/: - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/name={value-name}/: + /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/: get: tags: - - "tapi-common" - description: "returns tapi.common.NameAndValue" + - "tapi-connectivity" + summary: "returns tapi.path.computation.RoutingConstraint" + description: "none" parameters: - - name: "value-name" + - name: "uuid" in: "path" - description: "Id of name" + description: "Id of connectivity-service" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.path.computation.RoutingConstraint" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" 400: description: "Internal error" post: tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" + - "tapi-connectivity" + summary: "creates tapi.path.computation.RoutingConstraint" + description: "none" parameters: - - name: "value-name" + - name: "uuid" in: "path" - description: "Id of name" + description: "Id of connectivity-service" required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.path.computation.RoutingConstraint.body-param" + description: "tapi.path.computation.RoutingConstraint to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" responses: 201: description: "Object created" @@ -3509,20 +4023,21 @@ paths: description: "Object already exists" put: tags: - - "tapi-common" - description: "creates or updates tapi.common.NameAndValue" + - "tapi-connectivity" + summary: "creates or updates tapi.path.computation.RoutingConstraint" + description: "none" parameters: - - name: "value-name" + - name: "uuid" in: "path" - description: "Id of name" + description: "Id of connectivity-service" required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" + name: "tapi.path.computation.RoutingConstraint.body-param" + description: "tapi.path.computation.RoutingConstraint to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" responses: 201: description: "Object created" @@ -3532,12 +4047,13 @@ paths: description: "Object modified" delete: tags: - - "tapi-common" - description: "removes tapi.common.NameAndValue" + - "tapi-connectivity" + summary: "removes tapi.path.computation.RoutingConstraint" + description: "none" parameters: - - name: "value-name" + - name: "uuid" in: "path" - description: "Id of name" + description: "Id of connectivity-service" required: true type: "string" responses: @@ -3545,30 +4061,25 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/notification-context/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NotificationContext" - parameters: [] - responses: - 200: - description: "tapi.notification.NotificationContext" - schema: - $ref: "#/definitions/tapi.notification.NotificationContext" - 400: - description: "Internal error" + /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/cost-characteristic/: post: tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationContext" + - "tapi-connectivity" + summary: "creates tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" - in: "body" - name: "tapi.notification.NotificationContext.body-param" - description: "tapi.notification.NotificationContext to be added to list" + name: "tapi.topology.CostCharacteristic.body-param" + description: "tapi.topology.CostCharacteristic to be added to list" required: false schema: - $ref: "#/definitions/tapi.notification.NotificationContext" + $ref: "#/definitions/tapi.topology.CostCharacteristic" responses: 201: description: "Object created" @@ -3576,113 +4087,54 @@ paths: description: "Internal error" 409: description: "Object already exists" - put: + /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/cost-characteristic={cost-name}/: + get: tags: - - "tapi-notification" - description: "creates or updates tapi.notification.NotificationContext" + - "tapi-connectivity" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - - in: "body" - name: "tapi.notification.NotificationContext.body-param" - description: "tapi.notification.NotificationContext to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationContext" + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" responses: - 201: - description: "Object created" + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" 400: description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.notification.NotificationContext" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription/: - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationSubscriptionService" - parameters: - - in: "body" - name: "tapi.notification.NotificationSubscriptionService.body-param" - description: "tapi.notification.NotificationSubscriptionService to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NotificationSubscriptionService" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.NotificationSubscriptionService" - schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - 400: - description: "Internal error" - post: + put: tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationSubscriptionService" + - "tapi-connectivity" + summary: "creates or updates tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of connectivity-service" required: true type: "string" - - in: "body" - name: "tapi.notification.NotificationSubscriptionService.body-param" - description: "tapi.notification.NotificationSubscriptionService to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.notification.NotificationSubscriptionService" - parameters: - - name: "uuid" + - name: "cost-name" in: "path" - description: "Id of notif-subscription" + description: "Id of cost-characteristic" required: true type: "string" - in: "body" - name: "tapi.notification.NotificationSubscriptionService.body-param" - description: "tapi.notification.NotificationSubscriptionService to be added\ - \ or updated" + name: "tapi.topology.CostCharacteristic.body-param" + description: "tapi.topology.CostCharacteristic to be added or updated" required: false schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + $ref: "#/definitions/tapi.topology.CostCharacteristic" responses: 201: description: "Object created" @@ -3692,12 +4144,19 @@ paths: description: "Object modified" delete: tags: - - "tapi-notification" - description: "removes tapi.notification.NotificationSubscriptionService" + - "tapi-connectivity" + summary: "removes tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" required: true type: "string" responses: @@ -3705,23 +4164,25 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/name/: + /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/latency-characteristic/: post: tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" + - "tapi-connectivity" + summary: "creates tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of connectivity-service" required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.topology.LatencyCharacteristic.body-param" + description: "tapi.topology.LatencyCharacteristic to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" responses: 201: description: "Object created" @@ -3729,78 +4190,54 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/name={value-name}/: - get: + ? /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/ + : get: tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" + - "tapi-connectivity" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of connectivity-service" required: true type: "string" - - name: "value-name" + - name: "traffic-property-name" in: "path" - description: "Id of name" + description: "Id of latency-characteristic" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.topology.LatencyCharacteristic" schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" + - "tapi-connectivity" + summary: "creates or updates tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of connectivity-service" required: true type: "string" - - name: "value-name" + - name: "traffic-property-name" in: "path" - description: "Id of name" + description: "Id of latency-characteristic" required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" + name: "tapi.topology.LatencyCharacteristic.body-param" + description: "tapi.topology.LatencyCharacteristic to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" responses: 201: description: "Object created" @@ -3810,17 +4247,19 @@ paths: description: "Object modified" delete: tags: - - "tapi-notification" - description: "removes tapi.common.NameAndValue" + - "tapi-connectivity" + summary: "removes tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of connectivity-service" required: true type: "string" - - name: "value-name" + - name: "traffic-property-name" in: "path" - description: "Id of name" + description: "Id of latency-characteristic" required: true type: "string" responses: @@ -3828,63 +4267,77 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/notification-channel/: - get: + /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/risk-diversity-characteristic/: + post: tags: - - "tapi-notification" - description: "returns tapi.notification.NotificationChannel" + - "tapi-connectivity" + summary: "creates tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of connectivity-service" required: true type: "string" + - in: "body" + name: "tapi.topology.RiskCharacteristic.body-param" + description: "tapi.topology.RiskCharacteristic to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" responses: - 200: - description: "tapi.notification.NotificationChannel" - schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + ? /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/ + : get: tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationChannel" + - "tapi-connectivity" + summary: "returns tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-diversity-characteristic" required: true type: "string" - - in: "body" - name: "tapi.notification.NotificationChannel.body-param" - description: "tapi.notification.NotificationChannel to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" responses: - 201: - description: "Object created" + 200: + description: "tapi.topology.RiskCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - - "tapi-notification" - description: "creates or updates tapi.notification.NotificationChannel" + - "tapi-connectivity" + summary: "creates or updates tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-diversity-characteristic" required: true type: "string" - in: "body" - name: "tapi.notification.NotificationChannel.body-param" - description: "tapi.notification.NotificationChannel to be added or updated" + name: "tapi.topology.RiskCharacteristic.body-param" + description: "tapi.topology.RiskCharacteristic to be added or updated" required: false schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" + $ref: "#/definitions/tapi.topology.RiskCharacteristic" responses: 201: description: "Object created" @@ -3894,12 +4347,18 @@ paths: description: "Object modified" delete: tags: - - "tapi-notification" - description: "removes tapi.notification.NotificationChannel" + - "tapi-connectivity" + summary: "removes tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-diversity-characteristic" required: true type: "string" responses: @@ -3907,23 +4366,24 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/notification-channel/name/: + /data/context/connectivity-context/connectivity-service={uuid}/topology-constraint/: post: tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" + - "tapi-connectivity" + summary: "creates tapi.path.computation.TopologyConstraint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of connectivity-service" required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.path.computation.TopologyConstraint.body-param" + description: "tapi.path.computation.TopologyConstraint to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" responses: 201: description: "Object created" @@ -3931,78 +4391,52 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/notification-channel/name={value-name}/: + /data/context/connectivity-context/connectivity-service={uuid}/topology-constraint={local-id}/: get: tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" + - "tapi-connectivity" + summary: "returns tapi.path.computation.TopologyConstraint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of connectivity-service" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of name" + description: "Id of topology-constraint" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.path.computation.TopologyConstraint" schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" + - "tapi-connectivity" + summary: "creates or updates tapi.path.computation.TopologyConstraint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of connectivity-service" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of name" + description: "Id of topology-constraint" required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" + name: "tapi.path.computation.TopologyConstraint.body-param" + description: "tapi.path.computation.TopologyConstraint to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" responses: 201: description: "Object created" @@ -4012,17 +4446,18 @@ paths: description: "Object modified" delete: tags: - - "tapi-notification" - description: "removes tapi.common.NameAndValue" + - "tapi-connectivity" + summary: "removes tapi.path.computation.TopologyConstraint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of connectivity-service" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of name" + description: "Id of topology-constraint" required: true type: "string" responses: @@ -4030,48 +4465,60 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/: - get: + /data/context/connectivity-context/connectivity-service={uuid}/topology-constraint={local-id}/name/: + post: tags: - - "tapi-notification" - description: "returns tapi.notification.Notification" + - "tapi-connectivity" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of connectivity-service" required: true type: "string" - - name: "notification-uuid" + - name: "local-id" in: "path" - description: "Id of notification" + description: "Id of topology-constraint" required: true type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" responses: - 200: - description: "tapi.notification.Notification" - schema: - $ref: "#/definitions/tapi.notification.Notification" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/additional-info={value-name}/: + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/topology-constraint={local-id}/name={value-name}/: get: tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" + - "tapi-connectivity" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of connectivity-service" required: true type: "string" - - name: "notification-uuid" + - name: "local-id" in: "path" - description: "Id of notification" + description: "Id of topology-constraint" required: true type: "string" - name: "value-name" in: "path" - description: "Id of additional-info" + description: "Id of name" required: true type: "string" responses: @@ -4081,73 +4528,101 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/alarm-info/: - get: + put: tags: - - "tapi-notification" - description: "returns tapi.notification.AlarmInfo" + - "tapi-connectivity" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of connectivity-service" required: true type: "string" - - name: "notification-uuid" + - name: "local-id" in: "path" - description: "Id of notification" + description: "Id of topology-constraint" required: true type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" responses: - 200: - description: "tapi.notification.AlarmInfo" - schema: - $ref: "#/definitions/tapi.notification.AlarmInfo" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/changed-attributes={value-name}/: - get: + 204: + description: "Object modified" + delete: tags: - - "tapi-notification" - description: "returns tapi.notification.NameAndValueChange" + - "tapi-connectivity" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of connectivity-service" required: true type: "string" - - name: "notification-uuid" + - name: "local-id" in: "path" - description: "Id of notification" + description: "Id of topology-constraint" required: true type: "string" - name: "value-name" in: "path" - description: "Id of changed-attributes" + description: "Id of name" required: true type: "string" responses: - 200: - description: "tapi.notification.NameAndValueChange" - schema: - $ref: "#/definitions/tapi.notification.NameAndValueChange" 400: description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/name={value-name}/: + 204: + description: "Object deleted" + /data/context/name/: + post: + tags: + - "tapi-common" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/name={value-name}/: get: tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" + - "tapi-common" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - name: "value-name" in: "path" description: "Id of name" @@ -4160,91 +4635,77 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/target-object-name={value-name}/: - get: + put: tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" + - "tapi-common" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - name: "value-name" in: "path" - description: "Id of target-object-name" + description: "Id of name" required: true type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/tca-info/: - get: + 204: + description: "Object modified" + delete: tags: - - "tapi-notification" - description: "returns tapi.notification.TcaInfo" + - "tapi-common" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" + - name: "value-name" in: "path" - description: "Id of notification" + description: "Id of name" required: true type: "string" responses: - 200: - description: "tapi.notification.TcaInfo" - schema: - $ref: "#/definitions/tapi.notification.TcaInfo" 400: description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/subscription-filter/: + 204: + description: "Object deleted" + /data/context/notification-context/: get: tags: - "tapi-notification" - description: "returns tapi.notification.SubscriptionFilter" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" + summary: "returns tapi.notification.context.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: [] responses: 200: - description: "tapi.notification.SubscriptionFilter" + description: "tapi.notification.context.NotificationContext" schema: - $ref: "#/definitions/tapi.notification.SubscriptionFilter" + $ref: "#/definitions/tapi.notification.context.NotificationContext" 400: description: "Internal error" post: tags: - "tapi-notification" - description: "creates tapi.notification.SubscriptionFilter" + summary: "creates tapi.notification.context.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - in: "body" - name: "tapi.notification.SubscriptionFilter.body-param" - description: "tapi.notification.SubscriptionFilter to be added to list" + name: "tapi.notification.context.NotificationContext.body-param" + description: "tapi.notification.context.NotificationContext to be added to\ + \ list" required: false schema: - $ref: "#/definitions/tapi.notification.SubscriptionFilter" + $ref: "#/definitions/tapi.notification.context.NotificationContext" responses: 201: description: "Object created" @@ -4255,19 +4716,16 @@ paths: put: tags: - "tapi-notification" - description: "creates or updates tapi.notification.SubscriptionFilter" + summary: "creates or updates tapi.notification.context.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - in: "body" - name: "tapi.notification.SubscriptionFilter.body-param" - description: "tapi.notification.SubscriptionFilter to be added or updated" + name: "tapi.notification.context.NotificationContext.body-param" + description: "tapi.notification.context.NotificationContext to be added or\ + \ updated" required: false schema: - $ref: "#/definitions/tapi.notification.SubscriptionFilter" + $ref: "#/definitions/tapi.notification.context.NotificationContext" responses: 201: description: "Object created" @@ -4278,35 +4736,28 @@ paths: delete: tags: - "tapi-notification" - description: "removes tapi.notification.SubscriptionFilter" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" + summary: "removes tapi.notification.context.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: [] responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name/: + /data/context/notification-context/notif-subscription/: post: tags: - "tapi-notification" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.notification.NotificationSubscriptionService" + description: "none" parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.notification.NotificationSubscriptionService.body-param" + description: "tapi.notification.NotificationSubscriptionService to be added\ + \ to list" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" responses: 201: description: "Object created" @@ -4314,42 +4765,78 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name={value-name}/: + /data/context/notification-context/notif-subscription={uuid}/: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.notification.NotificationSubscriptionService" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of notif-subscription" required: true type: "string" - - name: "value-name" + responses: + 200: + description: "tapi.notification.NotificationSubscriptionService" + schema: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + 400: + description: "Internal error" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.notification.NotificationSubscriptionService" + description: "none" + parameters: + - name: "uuid" in: "path" - description: "Id of name" + description: "Id of notif-subscription" required: true type: "string" + - in: "body" + name: "tapi.notification.NotificationSubscriptionService.body-param" + description: "tapi.notification.NotificationSubscriptionService to be added\ + \ or updated" + required: false + schema: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" + 201: + description: "Object created" 400: description: "Internal error" - post: + 204: + description: "Object modified" + delete: tags: - "tapi-notification" - description: "creates tapi.common.NameAndValue" + summary: "removes tapi.notification.NotificationSubscriptionService" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of notif-subscription" required: true type: "string" - - name: "value-name" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notif-subscription={uuid}/name/: + post: + tags: + - "tapi-notification" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" in: "path" - description: "Id of name" + description: "Id of notif-subscription" required: true type: "string" - in: "body" @@ -4365,10 +4852,39 @@ paths: description: "Internal error" 409: description: "Object already exists" + /data/context/notification-context/notif-subscription={uuid}/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" put: tags: - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -4396,7 +4912,10 @@ paths: delete: tags: - "tapi-notification" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -4413,38 +4932,42 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/notification-context/notification={uuid}/: + /data/context/notification-context/notif-subscription={uuid}/notification-channel/: get: tags: - "tapi-notification" - description: "returns tapi.notification.Notification" + summary: "returns tapi.notification.NotificationChannel" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notification" + description: "Id of notif-subscription" required: true type: "string" responses: 200: - description: "tapi.notification.Notification" + description: "tapi.notification.NotificationChannel" schema: - $ref: "#/definitions/tapi.notification.Notification" + $ref: "#/definitions/tapi.notification.NotificationChannel" 400: description: "Internal error" - /data/context/notification-context/notification={uuid}/additional-info={value-name}/: + /data/context/notification-context/notif-subscription={uuid}/notification-channel/name={value-name}/: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of notification" + description: "Id of notif-subscription" required: true type: "string" - name: "value-name" in: "path" - description: "Id of additional-info" + description: "Id of name" required: true type: "string" responses: @@ -4454,84 +4977,110 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/notification-context/notification={uuid}/alarm-info/: + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/: get: tags: - "tapi-notification" - description: "returns tapi.notification.AlarmInfo" + summary: "returns tapi.notification.Notification" + description: "none" parameters: - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" in: "path" description: "Id of notification" required: true type: "string" responses: 200: - description: "tapi.notification.AlarmInfo" + description: "tapi.notification.Notification" schema: - $ref: "#/definitions/tapi.notification.AlarmInfo" + $ref: "#/definitions/tapi.notification.Notification" 400: description: "Internal error" - /data/context/notification-context/notification={uuid}/changed-attributes={value-name}/: + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/additional-info={value-name}/: get: tags: - "tapi-notification" - description: "returns tapi.notification.NameAndValueChange" + summary: "returns tapi.common.NameAndValue" + description: "none" parameters: - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" in: "path" description: "Id of notification" required: true type: "string" - name: "value-name" in: "path" - description: "Id of changed-attributes" + description: "Id of additional-info" required: true type: "string" responses: 200: - description: "tapi.notification.NameAndValueChange" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.notification.NameAndValueChange" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/notification-context/notification={uuid}/name={value-name}/: + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/changed-attributes={value-name}/: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.notification.NameAndValueChange" + description: "none" parameters: - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" in: "path" description: "Id of notification" required: true type: "string" - name: "value-name" in: "path" - description: "Id of name" + description: "Id of changed-attributes" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.notification.NameAndValueChange" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.notification.NameAndValueChange" 400: description: "Internal error" - /data/context/notification-context/notification={uuid}/target-object-name={value-name}/: + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/name={value-name}/: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" in: "path" description: "Id of notification" required: true type: "string" - name: "value-name" in: "path" - description: "Id of target-object-name" + description: "Id of name" required: true type: "string" responses: @@ -4541,48 +5090,71 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/notification-context/notification={uuid}/tca-info/: + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/target-object-name={value-name}/: get: tags: - "tapi-notification" - description: "returns tapi.notification.TcaInfo" + summary: "returns tapi.common.NameAndValue" + description: "none" parameters: - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" in: "path" description: "Id of notification" required: true type: "string" + - name: "value-name" + in: "path" + description: "Id of target-object-name" + required: true + type: "string" responses: 200: - description: "tapi.notification.TcaInfo" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.notification.TcaInfo" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/oam-context/: + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/: get: tags: - - "tapi-oam" - description: "returns tapi.oam.context.OamContext" - parameters: [] + - "tapi-notification" + summary: "returns tapi.notification.SubscriptionFilter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" responses: 200: - description: "tapi.oam.context.OamContext" + description: "tapi.notification.SubscriptionFilter" schema: - $ref: "#/definitions/tapi.oam.context.OamContext" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" 400: description: "Internal error" post: tags: - - "tapi-oam" - description: "creates tapi.oam.context.OamContext" + - "tapi-notification" + summary: "creates tapi.notification.SubscriptionFilter" + description: "none" parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" - in: "body" - name: "tapi.oam.context.OamContext.body-param" - description: "tapi.oam.context.OamContext to be added to list" + name: "tapi.notification.SubscriptionFilter.body-param" + description: "tapi.notification.SubscriptionFilter to be added to list" required: false schema: - $ref: "#/definitions/tapi.oam.context.OamContext" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" responses: 201: description: "Object created" @@ -4592,15 +5164,21 @@ paths: description: "Object already exists" put: tags: - - "tapi-oam" - description: "creates or updates tapi.oam.context.OamContext" + - "tapi-notification" + summary: "creates or updates tapi.notification.SubscriptionFilter" + description: "none" parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" - in: "body" - name: "tapi.oam.context.OamContext.body-param" - description: "tapi.oam.context.OamContext to be added or updated" + name: "tapi.notification.SubscriptionFilter.body-param" + description: "tapi.notification.SubscriptionFilter to be added or updated" required: false schema: - $ref: "#/definitions/tapi.oam.context.OamContext" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" responses: 201: description: "Object created" @@ -4610,202 +5188,225 @@ paths: description: "Object modified" delete: tags: - - "tapi-oam" - description: "removes tapi.oam.context.OamContext" - parameters: [] + - "tapi-notification" + summary: "removes tapi.notification.SubscriptionFilter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/meg={uuid}/: - get: + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name/: + post: tags: - - "tapi-oam" - description: "returns tapi.oam.oamcontext.Meg" + - "tapi-notification" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of meg" + description: "Id of notif-subscription" required: true type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" responses: - 200: - description: "tapi.oam.oamcontext.Meg" - schema: - $ref: "#/definitions/tapi.oam.oamcontext.Meg" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/oam-context/meg={uuid}/eth-meg-spec/: + 409: + description: "Object already exists" + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name={value-name}/: get: tags: - - "tapi-eth" - description: "returns tapi.eth.EthMegSpec" + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of meg" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.eth.EthMegSpec" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.eth.EthMegSpec" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/oam-context/meg={uuid}/mep={local-id}/: - get: + put: tags: - - "tapi-oam" - description: "returns tapi.oam.meg.Mep" + - "tapi-notification" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of meg" + description: "Id of notif-subscription" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of mep" + description: "Id of name" required: true type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" responses: - 200: - description: "tapi.oam.meg.Mep" - schema: - $ref: "#/definitions/tapi.oam.meg.Mep" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/oam-context/meg={uuid}/mep={local-id}/eth-mep-spec/: - get: + 204: + description: "Object modified" + delete: tags: - - "tapi-eth" - description: "returns tapi.eth.EthMepSpec" + - "tapi-notification" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of meg" + description: "Id of notif-subscription" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of mep" + description: "Id of name" required: true type: "string" responses: - 200: - description: "tapi.eth.EthMepSpec" - schema: - $ref: "#/definitions/tapi.eth.EthMepSpec" 400: description: "Internal error" - /data/context/oam-context/meg={uuid}/mep={local-id}/eth-mep-spec/eth-mep-common/: + 204: + description: "Object deleted" + /data/context/notification-context/notification={uuid}/: get: tags: - - "tapi-eth" - description: "returns tapi.eth.EthMepCommon" + - "tapi-notification" + summary: "returns tapi.notification.notificationcontext.Notification" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mep" + description: "Id of notification" required: true type: "string" responses: 200: - description: "tapi.eth.EthMepCommon" + description: "tapi.notification.notificationcontext.Notification" schema: - $ref: "#/definitions/tapi.eth.EthMepCommon" + $ref: "#/definitions/tapi.notification.notificationcontext.Notification" 400: description: "Internal error" - /data/context/oam-context/meg={uuid}/mep={local-id}/eth-mep-spec/eth-mep-sink/: + /data/context/notification-context/notification={uuid}/additional-info={value-name}/: get: tags: - - "tapi-eth" - description: "returns tapi.eth.EthMepSink" + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of meg" + description: "Id of notification" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of mep" + description: "Id of additional-info" required: true type: "string" responses: 200: - description: "tapi.eth.EthMepSink" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.eth.EthMepSink" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/oam-context/meg={uuid}/mep={local-id}/eth-mep-spec/eth-mep-sink/bandwidth-report/: + /data/context/notification-context/notification={uuid}/alarm-info/: get: tags: - - "tapi-eth" - description: "returns tapi.eth.BandwidthReport" + - "tapi-oam" + summary: "returns tapi.oam.AlarmInfo" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mep" + description: "Id of notification" required: true type: "string" responses: 200: - description: "tapi.eth.BandwidthReport" + description: "tapi.oam.AlarmInfo" schema: - $ref: "#/definitions/tapi.eth.BandwidthReport" + $ref: "#/definitions/tapi.oam.AlarmInfo" 400: description: "Internal error" - /data/context/oam-context/meg={uuid}/mep={local-id}/eth-mep-spec/eth-mep-source-pac/: + /data/context/notification-context/notification={uuid}/changed-attributes={value-name}/: get: tags: - - "tapi-eth" - description: "returns tapi.eth.EthMepSource" + - "tapi-notification" + summary: "returns tapi.notification.NameAndValueChange" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of meg" + description: "Id of notification" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of mep" + description: "Id of changed-attributes" required: true type: "string" responses: 200: - description: "tapi.eth.EthMepSource" + description: "tapi.notification.NameAndValueChange" schema: - $ref: "#/definitions/tapi.eth.EthMepSource" + $ref: "#/definitions/tapi.notification.NameAndValueChange" 400: description: "Internal error" - /data/context/oam-context/meg={uuid}/mep={local-id}/name={value-name}/: + /data/context/notification-context/notification={uuid}/name={value-name}/: get: tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mep" + description: "Id of notification" required: true type: "string" - name: "value-name" @@ -4820,156 +5421,171 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/oam-context/meg={uuid}/mip={local-id}/: + /data/context/notification-context/notification={uuid}/target-object-name={value-name}/: get: tags: - - "tapi-oam" - description: "returns tapi.oam.meg.Mip" + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of meg" + description: "Id of notification" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of mip" + description: "Id of target-object-name" required: true type: "string" responses: 200: - description: "tapi.oam.meg.Mip" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.oam.meg.Mip" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/oam-context/meg={uuid}/mip={local-id}/eth-mip-spec/: + /data/context/notification-context/notification={uuid}/tca-info/: get: tags: - - "tapi-eth" - description: "returns tapi.eth.EthMipSpec" + - "tapi-oam" + summary: "returns tapi.oam.TcaInfo" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mip" + description: "Id of notification" required: true type: "string" responses: 200: - description: "tapi.eth.EthMipSpec" + description: "tapi.oam.TcaInfo" schema: - $ref: "#/definitions/tapi.eth.EthMipSpec" + $ref: "#/definitions/tapi.oam.TcaInfo" 400: description: "Internal error" - /data/context/oam-context/meg={uuid}/mip={local-id}/name={value-name}/: + /data/context/notification-context/notification={uuid}/tca-info/oam-job/: get: tags: - "tapi-oam" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.oam.OamJobRef" + description: "MEF 35.1\r\n Identification of the PM Session for\ + \ which the TCA Function was configured." parameters: - name: "uuid" in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mip" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of notification" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.oam.OamJobRef" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.oam.OamJobRef" 400: description: "Internal error" - /data/context/oam-context/meg={uuid}/name={value-name}/: + /data/context/notification-context/notification={uuid}/tca-info/threshold-parameter/: get: tags: - "tapi-oam" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.oam.ThresholdParameter" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of notification" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.oam.ThresholdParameter" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.oam.ThresholdParameter" 400: description: "Internal error" - /data/context/oam-context/oam-job/: - post: + /data/context/notification-context/notification={uuid}/tca-info/threshold-parameter/pm-parameter-above-thrs/: + get: tags: - "tapi-oam" - description: "creates tapi.oam.oamcontext.OamJob" + summary: "returns tapi.oam.PmParameterValue" + description: "none" parameters: - - in: "body" - name: "tapi.oam.oamcontext.OamJob.body-param" - description: "tapi.oam.oamcontext.OamJob to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.oamcontext.OamJob" + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" responses: - 201: - description: "Object created" + 200: + description: "tapi.oam.PmParameterValue" + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-job={uuid}/: + /data/context/notification-context/notification={uuid}/tca-info/threshold-parameter/pm-parameter-below-thrs/: get: tags: - "tapi-oam" - description: "returns tapi.oam.oamcontext.OamJob" + summary: "returns tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of notification" required: true type: "string" responses: 200: - description: "tapi.oam.oamcontext.OamJob" + description: "tapi.oam.PmParameterValue" schema: - $ref: "#/definitions/tapi.oam.oamcontext.OamJob" + $ref: "#/definitions/tapi.oam.PmParameterValue" 400: description: "Internal error" - post: + /data/context/notification-context/notification={uuid}/tca-info/threshold-parameter/pm-parameter-clear-thrs/: + get: tags: - "tapi-oam" - description: "creates tapi.oam.oamcontext.OamJob" + summary: "returns tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of notification" required: true type: "string" + responses: + 200: + description: "tapi.oam.PmParameterValue" + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + 400: + description: "Internal error" + /data/context/oam-context/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.context.OamContext" + description: "Augments the base TAPI Context with OamService information" + parameters: [] + responses: + 200: + description: "tapi.oam.context.OamContext" + schema: + $ref: "#/definitions/tapi.oam.context.OamContext" + 400: + description: "Internal error" + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.context.OamContext" + description: "Augments the base TAPI Context with OamService information" + parameters: - in: "body" - name: "tapi.oam.oamcontext.OamJob.body-param" - description: "tapi.oam.oamcontext.OamJob to be added to list" + name: "tapi.oam.context.OamContext.body-param" + description: "tapi.oam.context.OamContext to be added to list" required: false schema: - $ref: "#/definitions/tapi.oam.oamcontext.OamJob" + $ref: "#/definitions/tapi.oam.context.OamContext" responses: 201: description: "Object created" @@ -4980,19 +5596,15 @@ paths: put: tags: - "tapi-oam" - description: "creates or updates tapi.oam.oamcontext.OamJob" + summary: "creates or updates tapi.oam.context.OamContext" + description: "Augments the base TAPI Context with OamService information" parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - in: "body" - name: "tapi.oam.oamcontext.OamJob.body-param" - description: "tapi.oam.oamcontext.OamJob to be added or updated" + name: "tapi.oam.context.OamContext.body-param" + description: "tapi.oam.context.OamContext to be added or updated" required: false schema: - $ref: "#/definitions/tapi.oam.oamcontext.OamJob" + $ref: "#/definitions/tapi.oam.context.OamContext" responses: 201: description: "Object created" @@ -5003,448 +5615,450 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.oam.oamcontext.OamJob" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" + summary: "removes tapi.oam.context.OamContext" + description: "Augments the base TAPI Context with OamService information" + parameters: [] responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/eth-link-trace-job/: + /data/context/oam-context/meg={uuid}/: get: tags: - - "tapi-eth" - description: "returns tapi.eth.EthLinkTraceJob" + - "tapi-oam" + summary: "returns tapi.oam.oamcontext.Meg" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of meg" required: true type: "string" responses: 200: - description: "tapi.eth.EthLinkTraceJob" + description: "tapi.oam.oamcontext.Meg" schema: - $ref: "#/definitions/tapi.eth.EthLinkTraceJob" + $ref: "#/definitions/tapi.oam.oamcontext.Meg" 400: description: "Internal error" - post: + /data/context/oam-context/meg={uuid}/eth-meg-spec/: + get: tags: - "tapi-eth" - description: "creates tapi.eth.EthLinkTraceJob" + summary: "returns tapi.eth.EthMegSpec" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of meg" required: true type: "string" - - in: "body" - name: "tapi.eth.EthLinkTraceJob.body-param" - description: "tapi.eth.EthLinkTraceJob to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthLinkTraceJob" responses: - 201: - description: "Object created" + 200: + description: "tapi.eth.EthMegSpec" + schema: + $ref: "#/definitions/tapi.eth.EthMegSpec" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + /data/context/oam-context/meg={uuid}/eth-meg-spec/eth-cfm-maintenance-association/: + get: tags: - "tapi-eth" - description: "creates or updates tapi.eth.EthLinkTraceJob" + summary: "returns tapi.eth.EthCfmMaintenanceAssociation" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of meg" required: true type: "string" - - in: "body" - name: "tapi.eth.EthLinkTraceJob.body-param" - description: "tapi.eth.EthLinkTraceJob to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthLinkTraceJob" responses: - 201: - description: "Object created" + 200: + description: "tapi.eth.EthCfmMaintenanceAssociation" + schema: + $ref: "#/definitions/tapi.eth.EthCfmMaintenanceAssociation" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + /data/context/oam-context/meg={uuid}/eth-meg-spec/eth-cfm-maintenance-association/maintenance-association-name/: + get: tags: - "tapi-eth" - description: "removes tapi.eth.EthLinkTraceJob" + summary: "returns tapi.eth.MaintenanceAssociationName" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ The Maintenance Association name and name format choice." parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of meg" required: true type: "string" responses: + 200: + description: "tapi.eth.MaintenanceAssociationName" + schema: + $ref: "#/definitions/tapi.eth.MaintenanceAssociationName" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/eth-link-trace-job/eth-lt-msg/: + /data/context/oam-context/meg={uuid}/eth-meg-spec/eth-cfm-maintenance-domain/: get: tags: - "tapi-eth" - description: "returns tapi.eth.EthOamOperationCommonPac" + summary: "returns tapi.eth.EthCfmMaintenanceDomain" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of meg" required: true type: "string" responses: 200: - description: "tapi.eth.EthOamOperationCommonPac" + description: "tapi.eth.EthCfmMaintenanceDomain" schema: - $ref: "#/definitions/tapi.eth.EthOamOperationCommonPac" + $ref: "#/definitions/tapi.eth.EthCfmMaintenanceDomain" 400: description: "Internal error" - post: + /data/context/oam-context/meg={uuid}/eth-meg-spec/eth-meg-common/: + get: tags: - "tapi-eth" - description: "creates tapi.eth.EthOamOperationCommonPac" + summary: "returns tapi.eth.EthMegCommon" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of meg" required: true type: "string" - - in: "body" - name: "tapi.eth.EthOamOperationCommonPac.body-param" - description: "tapi.eth.EthOamOperationCommonPac to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthOamOperationCommonPac" responses: - 201: - description: "Object created" + 200: + description: "tapi.eth.EthMegCommon" + schema: + $ref: "#/definitions/tapi.eth.EthMegCommon" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + /data/context/oam-context/meg={uuid}/mep={local-id}/: + get: tags: - - "tapi-eth" - description: "creates or updates tapi.eth.EthOamOperationCommonPac" + - "tapi-oam" + summary: "returns tapi.oam.meg.Mep" + description: "1. ME may have 0 MEPs (case of transit domains where at least\ + \ 1 MIP is present)\r\n 2. ME may have 1 MEP (case of edge\ + \ domaind, where the peer MEP is ouside the managed domain)\r\n \ + \ 3. ME may have 2 MEPs" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of meg" required: true type: "string" - - in: "body" - name: "tapi.eth.EthOamOperationCommonPac.body-param" - description: "tapi.eth.EthOamOperationCommonPac to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthOamOperationCommonPac" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-eth" - description: "removes tapi.eth.EthOamOperationCommonPac" - parameters: - - name: "uuid" + - name: "local-id" in: "path" - description: "Id of oam-job" + description: "Id of mep" required: true type: "string" responses: + 200: + description: "tapi.oam.meg.Mep" + schema: + $ref: "#/definitions/tapi.oam.meg.Mep" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/eth-loopback-job/: + /data/context/oam-context/meg={uuid}/mep={local-id}/eth-mep-spec/: get: tags: - "tapi-eth" - description: "returns tapi.eth.EthLoopbackJob" + summary: "returns tapi.eth.EthMepSpec" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mep" required: true type: "string" responses: 200: - description: "tapi.eth.EthLoopbackJob" + description: "tapi.eth.EthMepSpec" schema: - $ref: "#/definitions/tapi.eth.EthLoopbackJob" + $ref: "#/definitions/tapi.eth.EthMepSpec" 400: description: "Internal error" - post: + /data/context/oam-context/meg={uuid}/mep={local-id}/eth-mep-spec/eth-mep-common/: + get: tags: - "tapi-eth" - description: "creates tapi.eth.EthLoopbackJob" + summary: "returns tapi.eth.EthMepCommon" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mep" required: true type: "string" - - in: "body" - name: "tapi.eth.EthLoopbackJob.body-param" - description: "tapi.eth.EthLoopbackJob to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthLoopbackJob" responses: - 201: - description: "Object created" + 200: + description: "tapi.eth.EthMepCommon" + schema: + $ref: "#/definitions/tapi.eth.EthMepCommon" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + /data/context/oam-context/meg={uuid}/mep={local-id}/eth-mep-spec/eth-mep-sink/: + get: tags: - "tapi-eth" - description: "creates or updates tapi.eth.EthLoopbackJob" + summary: "returns tapi.eth.EthMepSink" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mep" required: true type: "string" - - in: "body" - name: "tapi.eth.EthLoopbackJob.body-param" - description: "tapi.eth.EthLoopbackJob to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthLoopbackJob" responses: - 201: - description: "Object created" + 200: + description: "tapi.eth.EthMepSink" + schema: + $ref: "#/definitions/tapi.eth.EthMepSink" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + /data/context/oam-context/meg={uuid}/mep={local-id}/eth-mep-spec/eth-mep-sink/bandwidth-report/: + get: tags: - "tapi-eth" - description: "removes tapi.eth.EthLoopbackJob" + summary: "returns tapi.eth.BandwidthReport" + description: "This attribute models the content of the bandwidth report received\ + \ by the MEP Sink from the peer MEP Source." parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mep" required: true type: "string" responses: + 200: + description: "tapi.eth.BandwidthReport" + schema: + $ref: "#/definitions/tapi.eth.BandwidthReport" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/eth-loopback-job/eth-lb-msg/: + /data/context/oam-context/meg={uuid}/mep={local-id}/eth-mep-spec/eth-mep-source/: get: tags: - "tapi-eth" - description: "returns tapi.eth.EthOamMsgCommonPac" + summary: "returns tapi.eth.EthMepSource" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mep" required: true type: "string" responses: 200: - description: "tapi.eth.EthOamMsgCommonPac" + description: "tapi.eth.EthMepSource" schema: - $ref: "#/definitions/tapi.eth.EthOamMsgCommonPac" + $ref: "#/definitions/tapi.eth.EthMepSource" 400: description: "Internal error" - post: + /data/context/oam-context/meg={uuid}/mep={local-id}/name={value-name}/: + get: tags: - - "tapi-eth" - description: "creates tapi.eth.EthOamMsgCommonPac" + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mep" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" required: true type: "string" - - in: "body" - name: "tapi.eth.EthOamMsgCommonPac.body-param" - description: "tapi.eth.EthOamMsgCommonPac to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthOamMsgCommonPac" responses: - 201: - description: "Object created" + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + /data/context/oam-context/meg={uuid}/mip={local-id}/: + get: tags: - - "tapi-eth" - description: "creates or updates tapi.eth.EthOamMsgCommonPac" + - "tapi-oam" + summary: "returns tapi.oam.meg.Mip" + description: "ME may 0, 1, or more MIPs" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mip" required: true type: "string" - - in: "body" - name: "tapi.eth.EthOamMsgCommonPac.body-param" - description: "tapi.eth.EthOamMsgCommonPac to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthOamMsgCommonPac" responses: - 201: - description: "Object created" + 200: + description: "tapi.oam.meg.Mip" + schema: + $ref: "#/definitions/tapi.oam.meg.Mip" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + /data/context/oam-context/meg={uuid}/mip={local-id}/eth-mip-spec/: + get: tags: - "tapi-eth" - description: "removes tapi.eth.EthOamMsgCommonPac" + summary: "returns tapi.eth.EthMipSpec" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mip" required: true type: "string" responses: + 200: + description: "tapi.eth.EthMipSpec" + schema: + $ref: "#/definitions/tapi.eth.EthMipSpec" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/eth-on-demand-1way-measurement-job/: + /data/context/oam-context/meg={uuid}/mip={local-id}/eth-mip-spec/eth-mip-common/: get: tags: - "tapi-eth" - description: "returns tapi.eth.EthOnDemand1wayMeasurementJob" + summary: "returns tapi.eth.EthMipCommon" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mip" required: true type: "string" responses: 200: - description: "tapi.eth.EthOnDemand1wayMeasurementJob" + description: "tapi.eth.EthMipCommon" schema: - $ref: "#/definitions/tapi.eth.EthOnDemand1wayMeasurementJob" + $ref: "#/definitions/tapi.eth.EthMipCommon" 400: description: "Internal error" - post: + /data/context/oam-context/meg={uuid}/mip={local-id}/name={value-name}/: + get: tags: - - "tapi-eth" - description: "creates tapi.eth.EthOnDemand1wayMeasurementJob" + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of meg" required: true type: "string" - - in: "body" - name: "tapi.eth.EthOnDemand1wayMeasurementJob.body-param" - description: "tapi.eth.EthOnDemand1wayMeasurementJob to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthOnDemand1wayMeasurementJob" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-eth" - description: "creates or updates tapi.eth.EthOnDemand1wayMeasurementJob" - parameters: - - name: "uuid" + - name: "local-id" in: "path" - description: "Id of oam-job" + description: "Id of mip" required: true type: "string" - - in: "body" - name: "tapi.eth.EthOnDemand1wayMeasurementJob.body-param" - description: "tapi.eth.EthOnDemand1wayMeasurementJob to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthOnDemand1wayMeasurementJob" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-eth" - description: "removes tapi.eth.EthOnDemand1wayMeasurementJob" - parameters: - - name: "uuid" + - name: "value-name" in: "path" - description: "Id of oam-job" + description: "Id of name" required: true type: "string" responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/eth-on-demand-1way-measurement-job/on-demand-control-1way-sink/: + /data/context/oam-context/meg={uuid}/name={value-name}/: get: tags: - - "tapi-eth" - description: "returns tapi.eth.EthOnDemandMeasurementJobControlSink" + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of meg" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.eth.EthOnDemandMeasurementJobControlSink" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.eth.EthOnDemandMeasurementJobControlSink" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" + /data/context/oam-context/oam-job/: post: tags: - - "tapi-eth" - description: "creates tapi.eth.EthOnDemandMeasurementJobControlSink" + - "tapi-oam" + summary: "creates tapi.oam.oamcontext.OamJob" + description: "none" parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - in: "body" - name: "tapi.eth.EthOnDemandMeasurementJobControlSink.body-param" - description: "tapi.eth.EthOnDemandMeasurementJobControlSink to be added to\ - \ list" + name: "tapi.oam.oamcontext.OamJob.body-param" + description: "tapi.oam.oamcontext.OamJob to be added to list" required: false schema: - $ref: "#/definitions/tapi.eth.EthOnDemandMeasurementJobControlSink" + $ref: "#/definitions/tapi.oam.oamcontext.OamJob" responses: 201: description: "Object created" @@ -5452,10 +6066,30 @@ paths: description: "Internal error" 409: description: "Object already exists" + /data/context/oam-context/oam-job={uuid}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.oamcontext.OamJob" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.oamcontext.OamJob" + schema: + $ref: "#/definitions/tapi.oam.oamcontext.OamJob" + 400: + description: "Internal error" put: tags: - - "tapi-eth" - description: "creates or updates tapi.eth.EthOnDemandMeasurementJobControlSink" + - "tapi-oam" + summary: "creates or updates tapi.oam.oamcontext.OamJob" + description: "none" parameters: - name: "uuid" in: "path" @@ -5463,12 +6097,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.eth.EthOnDemandMeasurementJobControlSink.body-param" - description: "tapi.eth.EthOnDemandMeasurementJobControlSink to be added or\ - \ updated" + name: "tapi.oam.oamcontext.OamJob.body-param" + description: "tapi.oam.oamcontext.OamJob to be added or updated" required: false schema: - $ref: "#/definitions/tapi.eth.EthOnDemandMeasurementJobControlSink" + $ref: "#/definitions/tapi.oam.oamcontext.OamJob" responses: 201: description: "Object created" @@ -5478,8 +6111,9 @@ paths: description: "Object modified" delete: tags: - - "tapi-eth" - description: "removes tapi.eth.EthOnDemandMeasurementJobControlSink" + - "tapi-oam" + summary: "removes tapi.oam.oamcontext.OamJob" + description: "none" parameters: - name: "uuid" in: "path" @@ -5491,1156 +6125,1309 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/eth-on-demand-1way-measurement-job/on-demand-control-1way-source/: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/: get: tags: - - "tapi-eth" - description: "returns tapi.eth.EthOnDemandMeasurementJobControlSource" + - "tapi-oam" + summary: "returns tapi.oam.oamjob.CurrentData" + description: "Granularity period of the CurrentData identifies the specific\ + \ CurrentData instance in the scope of this OamJob.\r\n For\ + \ example, typically at least\r\n one 15min and\r\n \ + \ one 24hr;\r\n optionally one additional configurable\ + \ (< 15min)" parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" responses: 200: - description: "tapi.eth.EthOnDemandMeasurementJobControlSource" + description: "tapi.oam.oamjob.CurrentData" schema: - $ref: "#/definitions/tapi.eth.EthOnDemandMeasurementJobControlSource" + $ref: "#/definitions/tapi.oam.oamjob.CurrentData" 400: description: "Internal error" - post: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/elapsed-time/: + get: tags: - - "tapi-eth" - description: "creates tapi.eth.EthOnDemandMeasurementJobControlSource" + - "tapi-oam" + summary: "returns tapi.common.TimeInterval" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - in: "body" - name: "tapi.eth.EthOnDemandMeasurementJobControlSource.body-param" - description: "tapi.eth.EthOnDemandMeasurementJobControlSource to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthOnDemandMeasurementJobControlSource" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-eth" - description: "creates or updates tapi.eth.EthOnDemandMeasurementJobControlSource" - parameters: - - name: "uuid" + - name: "local-id" in: "path" - description: "Id of oam-job" + description: "Id of current-data" required: true type: "string" - - in: "body" - name: "tapi.eth.EthOnDemandMeasurementJobControlSource.body-param" - description: "tapi.eth.EthOnDemandMeasurementJobControlSource to be added\ - \ or updated" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthOnDemandMeasurementJobControlSource" responses: - 201: - description: "Object created" + 200: + description: "tapi.common.TimeInterval" + schema: + $ref: "#/definitions/tapi.common.TimeInterval" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/elapsed-time/period={unit}/: + get: tags: - - "tapi-eth" - description: "removes tapi.eth.EthOnDemandMeasurementJobControlSource" + - "tapi-oam" + summary: "returns tapi.common.TimePeriod" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "unit" + in: "path" + description: "Id of period" + required: true + type: "string" responses: + 200: + description: "tapi.common.TimePeriod" + schema: + $ref: "#/definitions/tapi.common.TimePeriod" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/eth-on-demand-2way-measurement-job/: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-link-trace-result-data/: get: tags: - "tapi-eth" - description: "returns tapi.eth.EthOnDemand2wayMeasurementJob" + summary: "returns tapi.eth.EthLinkTraceResultData" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" responses: 200: - description: "tapi.eth.EthOnDemand2wayMeasurementJob" + description: "tapi.eth.EthLinkTraceResultData" schema: - $ref: "#/definitions/tapi.eth.EthOnDemand2wayMeasurementJob" + $ref: "#/definitions/tapi.eth.EthLinkTraceResultData" 400: description: "Internal error" - post: + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-link-trace-result-data/eth-cfm-link-trace-result-data={seq-number}/ + : get: tags: - "tapi-eth" - description: "creates tapi.eth.EthOnDemand2wayMeasurementJob" + summary: "returns tapi.eth.EthCfmLinkTraceResultData" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - in: "body" - name: "tapi.eth.EthOnDemand2wayMeasurementJob.body-param" - description: "tapi.eth.EthOnDemand2wayMeasurementJob to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthOnDemand2wayMeasurementJob" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "seq-number" + in: "path" + description: "Id of eth-cfm-link-trace-result-data" + required: true + type: "integer" + format: "int32" responses: - 201: - description: "Object created" + 200: + description: "tapi.eth.EthCfmLinkTraceResultData" + schema: + $ref: "#/definitions/tapi.eth.EthCfmLinkTraceResultData" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-link-trace-result-data/eth-cfm-link-trace-result-data={seq-number}/chassis-id/ + : get: tags: - "tapi-eth" - description: "creates or updates tapi.eth.EthOnDemand2wayMeasurementJob" + summary: "returns tapi.eth.LldpChassisIdSubtype" + description: "MEF 38:\r\n The chassis-id-subtype contains the\ + \ chassis ID entity that is listed in the chassis ID field. This is a combination\ + \ of the 'Chassis ID Subtype' and 'chsssis ID' fields.\r\n \ + \ IEEE P802.1Qcx/D0.3:\r\n The Chassis ID returned in the Sender\ + \ ID TLV of the LTR, if any.\r\n The format of a chassis identifier\ + \ string. Objects of this type are always used with an associated lldp-chassis-is-subtype\ + \ object, which identifies the format of the particular lldp-chassis-id object\ + \ instance.\r\n If the associated lldp-chassis-id-subtype object\ + \ has a value of chassis-component, then the octet string identifies a particular\ + \ instance of the entPhysicalAlias object (defined in IETF RFC 2737) for a\ + \ chassis component (i.e., an entPhysicalClass value of chassis(3)).\r\n \ + \ If the associated lldp-chassis-id-subtype object has a value\ + \ of interface-alias, then the octet string identifies a particular instance\ + \ of the ifAlias object (defined in IETF RFC 2863) for an interface on the\ + \ containing chassis.\r\n If the particular ifAlias object\ + \ does not contain any values, another chassis identifier type should be used." parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - in: "body" - name: "tapi.eth.EthOnDemand2wayMeasurementJob.body-param" - description: "tapi.eth.EthOnDemand2wayMeasurementJob to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthOnDemand2wayMeasurementJob" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "seq-number" + in: "path" + description: "Id of eth-cfm-link-trace-result-data" + required: true + type: "integer" + format: "int32" responses: - 201: - description: "Object created" + 200: + description: "tapi.eth.LldpChassisIdSubtype" + schema: + $ref: "#/definitions/tapi.eth.LldpChassisIdSubtype" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-link-trace-result-data/eth-cfm-link-trace-result-data={seq-number}/egress-port-id/ + : get: tags: - "tapi-eth" - description: "removes tapi.eth.EthOnDemand2wayMeasurementJob" + summary: "returns tapi.eth.LldpPortIdSubtype" + description: "MEF 38:\r\n IEEE P802.1Qcx/D0.3:\r\n \ + \ Egress Port ID.\r\n IEEE P802.1Qcx/D0.3:\r\n \ + \ If the egressActionField attribute contains the value EGRESS-NO-TLV,\ + \ then the contents of this attribute are meaningless." parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "seq-number" + in: "path" + description: "Id of eth-cfm-link-trace-result-data" + required: true + type: "integer" + format: "int32" responses: + 200: + description: "tapi.eth.LldpPortIdSubtype" + schema: + $ref: "#/definitions/tapi.eth.LldpPortIdSubtype" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/eth-on-demand-2way-measurement-job/on-demand-control-2way-source/: - get: + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-link-trace-result-data/eth-cfm-link-trace-result-data={seq-number}/ingress-port-id/ + : get: tags: - "tapi-eth" - description: "returns tapi.eth.EthOnDemandMeasurementJobControlSource" + summary: "returns tapi.eth.LldpPortIdSubtype" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ Ingress Port ID.\r\n IEEE P802.1Qcx/D0.3:\r\n \ + \ If the ingressActionField attribute contains the value INGRESS-NO-TLV,\ + \ then the contents of this attribute are meaningless." parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "seq-number" + in: "path" + description: "Id of eth-cfm-link-trace-result-data" + required: true + type: "integer" + format: "int32" responses: 200: - description: "tapi.eth.EthOnDemandMeasurementJobControlSource" + description: "tapi.eth.LldpPortIdSubtype" schema: - $ref: "#/definitions/tapi.eth.EthOnDemandMeasurementJobControlSource" + $ref: "#/definitions/tapi.eth.LldpPortIdSubtype" 400: description: "Internal error" - post: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-link-trace-result-data/result-list={source-address}/: + get: tags: - "tapi-eth" - description: "creates tapi.eth.EthOnDemandMeasurementJobControlSource" + summary: "returns tapi.eth.LinkTraceResult" + description: "G.8052: This parameter returns the results of the LT process.\ + \ It contains a list of the result received from the individual LTR frames.\r\ + \n The result from the individual LTR frame include the Source\ + \ Mac Address, the TTL, and TLV." parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - in: "body" - name: "tapi.eth.EthOnDemandMeasurementJobControlSource.body-param" - description: "tapi.eth.EthOnDemandMeasurementJobControlSource to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthOnDemandMeasurementJobControlSource" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "source-address" + in: "path" + description: "Id of result-list" + required: true + type: "string" responses: - 201: - description: "Object created" + 200: + description: "tapi.eth.LinkTraceResult" + schema: + $ref: "#/definitions/tapi.eth.LinkTraceResult" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-loopback-result-data/: + get: tags: - "tapi-eth" - description: "creates or updates tapi.eth.EthOnDemandMeasurementJobControlSource" + summary: "returns tapi.eth.EthLoopbackResultData" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - in: "body" - name: "tapi.eth.EthOnDemandMeasurementJobControlSource.body-param" - description: "tapi.eth.EthOnDemandMeasurementJobControlSource to be added\ - \ or updated" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthOnDemandMeasurementJobControlSource" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" responses: - 201: - description: "Object created" + 200: + description: "tapi.eth.EthLoopbackResultData" + schema: + $ref: "#/definitions/tapi.eth.EthLoopbackResultData" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-on-demand-1-dm-performance-data/: + get: tags: - "tapi-eth" - description: "removes tapi.eth.EthOnDemandMeasurementJobControlSource" + summary: "returns tapi.eth.EthOnDemand1DmPerformanceData" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" responses: + 200: + description: "tapi.eth.EthOnDemand1DmPerformanceData" + schema: + $ref: "#/definitions/tapi.eth.EthOnDemand1DmPerformanceData" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/eth-pro-active-1way-measurement-job/: - get: + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-on-demand-1-dm-performance-data/samples-near-end-1-dm-parameters/ + : get: tags: - "tapi-eth" - description: "returns tapi.eth.EthProActive1wayMeasurementJob" + summary: "returns tapi.eth.SamplesDmPerformanceParameters" + description: "This attribute contains the results of an on-demand frame delay\ + \ measurement job in the ingress direction." parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" responses: 200: - description: "tapi.eth.EthProActive1wayMeasurementJob" + description: "tapi.eth.SamplesDmPerformanceParameters" schema: - $ref: "#/definitions/tapi.eth.EthProActive1wayMeasurementJob" + $ref: "#/definitions/tapi.eth.SamplesDmPerformanceParameters" 400: description: "Internal error" - post: + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-on-demand-1-dm-performance-data/statistical-near-end-1-dm-parameters/ + : get: tags: - "tapi-eth" - description: "creates tapi.eth.EthProActive1wayMeasurementJob" + summary: "returns tapi.eth.StatisticalDmPerformanceParameters" + description: "This attribute contains the statistical near end performnace parameters." parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - in: "body" - name: "tapi.eth.EthProActive1wayMeasurementJob.body-param" - description: "tapi.eth.EthProActive1wayMeasurementJob to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthProActive1wayMeasurementJob" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" responses: - 201: - description: "Object created" + 200: + description: "tapi.eth.StatisticalDmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-on-demand-1-dm-source-performance-data/: + get: tags: - "tapi-eth" - description: "creates or updates tapi.eth.EthProActive1wayMeasurementJob" + summary: "returns tapi.eth.EthOnDemand1DmSourcePerformanceData" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - in: "body" - name: "tapi.eth.EthProActive1wayMeasurementJob.body-param" - description: "tapi.eth.EthProActive1wayMeasurementJob to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthProActive1wayMeasurementJob" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" responses: - 201: - description: "Object created" + 200: + description: "tapi.eth.EthOnDemand1DmSourcePerformanceData" + schema: + $ref: "#/definitions/tapi.eth.EthOnDemand1DmSourcePerformanceData" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-on-demand-1-lm-performance-data/: + get: tags: - "tapi-eth" - description: "removes tapi.eth.EthProActive1wayMeasurementJob" + summary: "returns tapi.eth.EthOnDemand1LmPerformanceData" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" responses: + 200: + description: "tapi.eth.EthOnDemand1LmPerformanceData" + schema: + $ref: "#/definitions/tapi.eth.EthOnDemand1LmPerformanceData" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/eth-pro-active-1way-measurement-job/pro-active-control-1way-sink/: - get: + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-on-demand-1-lm-performance-data/statistical-near-end-1-lm-parameters/ + : get: tags: - "tapi-eth" - description: "returns tapi.eth.EthProActiveMeasurementJobControlSink" + summary: "returns tapi.eth.StatisticalLmPerformanceParameters" + description: "This attribute contains the statistical near end performnace parameters." parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" responses: 200: - description: "tapi.eth.EthProActiveMeasurementJobControlSink" + description: "tapi.eth.StatisticalLmPerformanceParameters" schema: - $ref: "#/definitions/tapi.eth.EthProActiveMeasurementJobControlSink" + $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" 400: description: "Internal error" - post: + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-on-demand-1-lm-performance-data/total-counters-near-end-1-lm-parameters/ + : get: tags: - "tapi-eth" - description: "creates tapi.eth.EthProActiveMeasurementJobControlSink" + summary: "returns tapi.eth.TotalCountersLmPerformanceParameters" + description: "This attribute contains the results of an on-demand synthetic\ + \ loss measurement job in the ingress direction." parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - in: "body" - name: "tapi.eth.EthProActiveMeasurementJobControlSink.body-param" - description: "tapi.eth.EthProActiveMeasurementJobControlSink to be added to\ - \ list" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthProActiveMeasurementJobControlSink" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" responses: - 201: - description: "Object created" + 200: + description: "tapi.eth.TotalCountersLmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.TotalCountersLmPerformanceParameters" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-on-demand-1-lm-source-performance-data/: + get: tags: - "tapi-eth" - description: "creates or updates tapi.eth.EthProActiveMeasurementJobControlSink" + summary: "returns tapi.eth.EthOnDemand1LmSourcePerformanceData" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - in: "body" - name: "tapi.eth.EthProActiveMeasurementJobControlSink.body-param" - description: "tapi.eth.EthProActiveMeasurementJobControlSink to be added or\ - \ updated" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthProActiveMeasurementJobControlSink" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" responses: - 201: - description: "Object created" + 200: + description: "tapi.eth.EthOnDemand1LmSourcePerformanceData" + schema: + $ref: "#/definitions/tapi.eth.EthOnDemand1LmSourcePerformanceData" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-on-demand-dm-performance-data/: + get: tags: - "tapi-eth" - description: "removes tapi.eth.EthProActiveMeasurementJobControlSink" + summary: "returns tapi.eth.EthOnDemandDmPerformanceData" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" responses: + 200: + description: "tapi.eth.EthOnDemandDmPerformanceData" + schema: + $ref: "#/definitions/tapi.eth.EthOnDemandDmPerformanceData" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/eth-pro-active-1way-measurement-job/pro-active-control-1way-source/: - get: + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-on-demand-dm-performance-data/samples-far-end-dm-parameters/ + : get: tags: - "tapi-eth" - description: "returns tapi.eth.EthProActiveMeasurementJobControlSource" + summary: "returns tapi.eth.SamplesDmPerformanceParameters" + description: "This attribute contains the results of an on-demand frame delay\ + \ measurement job in the ingress direction." parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" responses: 200: - description: "tapi.eth.EthProActiveMeasurementJobControlSource" + description: "tapi.eth.SamplesDmPerformanceParameters" schema: - $ref: "#/definitions/tapi.eth.EthProActiveMeasurementJobControlSource" + $ref: "#/definitions/tapi.eth.SamplesDmPerformanceParameters" 400: description: "Internal error" - post: + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-on-demand-dm-performance-data/samples-near-end-dm-parameters/ + : get: tags: - "tapi-eth" - description: "creates tapi.eth.EthProActiveMeasurementJobControlSource" + summary: "returns tapi.eth.SamplesDmPerformanceParameters" + description: "This attribute contains the results of an on-demand frame delay\ + \ measurement job in the ingress direction." parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - in: "body" - name: "tapi.eth.EthProActiveMeasurementJobControlSource.body-param" - description: "tapi.eth.EthProActiveMeasurementJobControlSource to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthProActiveMeasurementJobControlSource" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" responses: - 201: - description: "Object created" + 200: + description: "tapi.eth.SamplesDmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.SamplesDmPerformanceParameters" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-on-demand-dm-performance-data/statistical-bi-dir-dm-parameters/ + : get: tags: - "tapi-eth" - description: "creates or updates tapi.eth.EthProActiveMeasurementJobControlSource" + summary: "returns tapi.eth.StatisticalDmPerformanceParameters" + description: "This attribute contains the statistical bidirectional performnace\ + \ parameters." parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - in: "body" - name: "tapi.eth.EthProActiveMeasurementJobControlSource.body-param" - description: "tapi.eth.EthProActiveMeasurementJobControlSource to be added\ - \ or updated" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthProActiveMeasurementJobControlSource" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" responses: - 201: - description: "Object created" + 200: + description: "tapi.eth.StatisticalDmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-on-demand-dm-performance-data/statistical-far-end-dm-parameters/ + : get: tags: - "tapi-eth" - description: "removes tapi.eth.EthProActiveMeasurementJobControlSource" + summary: "returns tapi.eth.StatisticalDmPerformanceParameters" + description: "This attribute contains the statistical far end performnace parameters." parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" responses: + 200: + description: "tapi.eth.StatisticalDmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/eth-pro-active-2way-measurement-job/: - get: + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-on-demand-dm-performance-data/statistical-near-end-dm-parameters/ + : get: tags: - "tapi-eth" - description: "returns tapi.eth.EthProActive2wayMeasurementJob" + summary: "returns tapi.eth.StatisticalDmPerformanceParameters" + description: "This attribute contains the statistical near end performnace parameters." parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" responses: 200: - description: "tapi.eth.EthProActive2wayMeasurementJob" + description: "tapi.eth.StatisticalDmPerformanceParameters" schema: - $ref: "#/definitions/tapi.eth.EthProActive2wayMeasurementJob" + $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" 400: description: "Internal error" - post: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-on-demand-lm-performance-data/: + get: tags: - "tapi-eth" - description: "creates tapi.eth.EthProActive2wayMeasurementJob" + summary: "returns tapi.eth.EthOnDemandLmPerformanceData" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - in: "body" - name: "tapi.eth.EthProActive2wayMeasurementJob.body-param" - description: "tapi.eth.EthProActive2wayMeasurementJob to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthProActive2wayMeasurementJob" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" responses: - 201: - description: "Object created" + 200: + description: "tapi.eth.EthOnDemandLmPerformanceData" + schema: + $ref: "#/definitions/tapi.eth.EthOnDemandLmPerformanceData" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-on-demand-lm-performance-data/statistical-far-end-lm-parameters/ + : get: tags: - "tapi-eth" - description: "creates or updates tapi.eth.EthProActive2wayMeasurementJob" + summary: "returns tapi.eth.StatisticalLmPerformanceParameters" + description: "This attribute contains the statistical far end performnace parameters." parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - in: "body" - name: "tapi.eth.EthProActive2wayMeasurementJob.body-param" - description: "tapi.eth.EthProActive2wayMeasurementJob to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthProActive2wayMeasurementJob" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" responses: - 201: - description: "Object created" + 200: + description: "tapi.eth.StatisticalLmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-on-demand-lm-performance-data/statistical-near-end-lm-parameters/ + : get: tags: - "tapi-eth" - description: "removes tapi.eth.EthProActive2wayMeasurementJob" + summary: "returns tapi.eth.StatisticalLmPerformanceParameters" + description: "This attribute contains the statistical near end performnace parameters." parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" responses: + 200: + description: "tapi.eth.StatisticalLmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/eth-pro-active-2way-measurement-job/pro-active-control-2way-source/: - get: + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-on-demand-lm-performance-data/total-counters-far-end-lm-parameters/ + : get: tags: - "tapi-eth" - description: "returns tapi.eth.EthProActiveMeasurementJobControlSource" + summary: "returns tapi.eth.TotalCountersLmPerformanceParameters" + description: "This attribute contains the results of an on-demand synthetic\ + \ loss measurement job in the egress direction." parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" responses: 200: - description: "tapi.eth.EthProActiveMeasurementJobControlSource" + description: "tapi.eth.TotalCountersLmPerformanceParameters" schema: - $ref: "#/definitions/tapi.eth.EthProActiveMeasurementJobControlSource" + $ref: "#/definitions/tapi.eth.TotalCountersLmPerformanceParameters" 400: description: "Internal error" - post: + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-on-demand-lm-performance-data/total-counters-near-end-lm-parameters/ + : get: tags: - "tapi-eth" - description: "creates tapi.eth.EthProActiveMeasurementJobControlSource" + summary: "returns tapi.eth.TotalCountersLmPerformanceParameters" + description: "This attribute contains the results of an on-demand synthetic\ + \ loss measurement job in the ingress direction." parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - in: "body" - name: "tapi.eth.EthProActiveMeasurementJobControlSource.body-param" - description: "tapi.eth.EthProActiveMeasurementJobControlSource to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthProActiveMeasurementJobControlSource" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" responses: - 201: - description: "Object created" + 200: + description: "tapi.eth.TotalCountersLmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.TotalCountersLmPerformanceParameters" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-pro-active-1-dm-performance-data/: + get: tags: - "tapi-eth" - description: "creates or updates tapi.eth.EthProActiveMeasurementJobControlSource" + summary: "returns tapi.eth.EthProActive1DmPerformanceData" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - in: "body" - name: "tapi.eth.EthProActiveMeasurementJobControlSource.body-param" - description: "tapi.eth.EthProActiveMeasurementJobControlSource to be added\ - \ or updated" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthProActiveMeasurementJobControlSource" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" responses: - 201: - description: "Object created" + 200: + description: "tapi.eth.EthProActive1DmPerformanceData" + schema: + $ref: "#/definitions/tapi.eth.EthProActive1DmPerformanceData" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-pro-active-1-dm-performance-data/statistical-near-end-1-dm-parameters/ + : get: tags: - "tapi-eth" - description: "removes tapi.eth.EthProActiveMeasurementJobControlSource" + summary: "returns tapi.eth.StatisticalDmPerformanceParameters" + description: "This attribute contains the statistical near end performnace parameters." parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" responses: + 200: + description: "tapi.eth.StatisticalDmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/eth-test-job/: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-pro-active-1-dm-source-performance-data/: get: tags: - "tapi-eth" - description: "returns tapi.eth.EthTestJob" + summary: "returns tapi.eth.EthProActive1DmSourcePerformanceData" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" responses: 200: - description: "tapi.eth.EthTestJob" + description: "tapi.eth.EthProActive1DmSourcePerformanceData" schema: - $ref: "#/definitions/tapi.eth.EthTestJob" + $ref: "#/definitions/tapi.eth.EthProActive1DmSourcePerformanceData" 400: description: "Internal error" - post: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-pro-active-1-lm-performance-data/: + get: tags: - "tapi-eth" - description: "creates tapi.eth.EthTestJob" + summary: "returns tapi.eth.EthProActive1LmPerformanceData" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - in: "body" - name: "tapi.eth.EthTestJob.body-param" - description: "tapi.eth.EthTestJob to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthTestJob" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" responses: - 201: - description: "Object created" + 200: + description: "tapi.eth.EthProActive1LmPerformanceData" + schema: + $ref: "#/definitions/tapi.eth.EthProActive1LmPerformanceData" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-pro-active-1-lm-performance-data/statistical-near-end-1-lm-parameters/ + : get: tags: - "tapi-eth" - description: "creates or updates tapi.eth.EthTestJob" + summary: "returns tapi.eth.StatisticalLmPerformanceParameters" + description: "This attribute contains the statistical near end performnace parameters." parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - in: "body" - name: "tapi.eth.EthTestJob.body-param" - description: "tapi.eth.EthTestJob to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthTestJob" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" responses: - 201: - description: "Object created" + 200: + description: "tapi.eth.StatisticalLmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-pro-active-1-lm-performance-data/total-counters-near-end-1-lm-parameters/ + : get: tags: - "tapi-eth" - description: "removes tapi.eth.EthTestJob" + summary: "returns tapi.eth.TotalCountersLmPerformanceParameters" + description: "This attribute contains the results of an on-demand synthetic\ + \ loss measurement job in the ingress direction." parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" responses: + 200: + description: "tapi.eth.TotalCountersLmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.TotalCountersLmPerformanceParameters" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/eth-test-job/eth-test-msg/: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-pro-active-1-lm-source-performance-data/: get: tags: - "tapi-eth" - description: "returns tapi.eth.EthOamMsgCommonPac" + summary: "returns tapi.eth.EthProActive1LmSourcePerformanceData" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" responses: 200: - description: "tapi.eth.EthOamMsgCommonPac" + description: "tapi.eth.EthProActive1LmSourcePerformanceData" schema: - $ref: "#/definitions/tapi.eth.EthOamMsgCommonPac" + $ref: "#/definitions/tapi.eth.EthProActive1LmSourcePerformanceData" 400: description: "Internal error" - post: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-pro-active-dm-performance-data/: + get: tags: - "tapi-eth" - description: "creates tapi.eth.EthOamMsgCommonPac" + summary: "returns tapi.eth.EthProActiveDmPerformanceData" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - in: "body" - name: "tapi.eth.EthOamMsgCommonPac.body-param" - description: "tapi.eth.EthOamMsgCommonPac to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthOamMsgCommonPac" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" responses: - 201: - description: "Object created" + 200: + description: "tapi.eth.EthProActiveDmPerformanceData" + schema: + $ref: "#/definitions/tapi.eth.EthProActiveDmPerformanceData" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-pro-active-dm-performance-data/statistical-bi-dir-dm-parameters/ + : get: tags: - "tapi-eth" - description: "creates or updates tapi.eth.EthOamMsgCommonPac" + summary: "returns tapi.eth.StatisticalDmPerformanceParameters" + description: "This attribute contains the statistical bidirectional performnace\ + \ parameters." parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - in: "body" - name: "tapi.eth.EthOamMsgCommonPac.body-param" - description: "tapi.eth.EthOamMsgCommonPac to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthOamMsgCommonPac" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" responses: - 201: - description: "Object created" + 200: + description: "tapi.eth.StatisticalDmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-pro-active-dm-performance-data/statistical-far-end-dm-parameters/ + : get: tags: - "tapi-eth" - description: "removes tapi.eth.EthOamMsgCommonPac" + summary: "returns tapi.eth.StatisticalDmPerformanceParameters" + description: "This attribute contains the statistical far end performnace parameters." parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" responses: + 200: + description: "tapi.eth.StatisticalDmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/name/: - post: + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-pro-active-dm-performance-data/statistical-near-end-dm-parameters/ + : get: tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" + - "tapi-eth" + summary: "returns tapi.eth.StatisticalDmPerformanceParameters" + description: "This attribute contains the statistical near end performnace parameters." parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" responses: - 201: - description: "Object created" + 200: + description: "tapi.eth.StatisticalDmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-job={uuid}/name={value-name}/: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-pro-active-lm-performance-data/: get: tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" + - "tapi-eth" + summary: "returns tapi.eth.EthProActiveLmPerformanceData" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of name" + description: "Id of current-data" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.eth.EthProActiveLmPerformanceData" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.eth.EthProActiveLmPerformanceData" 400: description: "Internal error" - post: + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-pro-active-lm-performance-data/statistical-far-end-lm-parameters/ + : get: tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" + - "tapi-eth" + summary: "returns tapi.eth.StatisticalLmPerformanceParameters" + description: "This attribute contains the statistical far end performnace parameters." parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of name" + description: "Id of current-data" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.eth.StatisticalLmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-pro-active-lm-performance-data/statistical-near-end-lm-parameters/ + : get: tags: - - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" + - "tapi-eth" + summary: "returns tapi.eth.StatisticalLmPerformanceParameters" + description: "This attribute contains the statistical near end performnace parameters." parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of name" + description: "Id of current-data" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.eth.StatisticalLmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-pro-active-lm-performance-data/total-counters-far-end-lm-parameters/ + : get: tags: - - "tapi-oam" - description: "removes tapi.common.NameAndValue" + - "tapi-eth" + summary: "returns tapi.eth.TotalCountersLmPerformanceParameters" + description: "This attribute contains the results of an on-demand synthetic\ + \ loss measurement job in the egress direction." parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/oam-profile/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.OamProfileRef" - parameters: - - name: "uuid" + - name: "local-id" in: "path" - description: "Id of oam-job" + description: "Id of current-data" required: true type: "string" responses: 200: - description: "tapi.oam.OamProfileRef" + description: "tapi.eth.TotalCountersLmPerformanceParameters" schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" + $ref: "#/definitions/tapi.eth.TotalCountersLmPerformanceParameters" 400: description: "Internal error" - post: + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-pro-active-lm-performance-data/total-counters-near-end-lm-parameters/ + : get: tags: - - "tapi-oam" - description: "creates tapi.oam.OamProfileRef" + - "tapi-eth" + summary: "returns tapi.eth.TotalCountersLmPerformanceParameters" + description: "This attribute contains the results of an on-demand synthetic\ + \ loss measurement job in the ingress direction." parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - in: "body" - name: "tapi.oam.OamProfileRef.body-param" - description: "tapi.oam.OamProfileRef to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamProfileRef" - parameters: - - name: "uuid" + - name: "local-id" in: "path" - description: "Id of oam-job" + description: "Id of current-data" required: true type: "string" - - in: "body" - name: "tapi.oam.OamProfileRef.body-param" - description: "tapi.oam.OamProfileRef to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" responses: - 201: - description: "Object created" + 200: + description: "tapi.eth.TotalCountersLmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.TotalCountersLmPerformanceParameters" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-test-result-data/: + get: tags: - - "tapi-oam" - description: "removes tapi.oam.OamProfileRef" + - "tapi-eth" + summary: "returns tapi.eth.EthTestResultData" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/oam-service-end-point/: - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamServiceEndPointRef" - parameters: - - name: "uuid" + - name: "local-id" in: "path" - description: "Id of oam-job" + description: "Id of current-data" required: true type: "string" - - in: "body" - name: "tapi.oam.OamServiceEndPointRef.body-param" - description: "tapi.oam.OamServiceEndPointRef to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPointRef" responses: - 201: - description: "Object created" + 200: + description: "tapi.eth.EthTestResultData" + schema: + $ref: "#/definitions/tapi.eth.EthTestResultData" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-job={uuid}/oam-service-end-point={oam-service-uuid},{oam-service-end-point-local-id}/: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/: get: tags: - "tapi-oam" - description: "returns tapi.oam.OamServiceEndPointRef" + summary: "returns tapi.oam.currentdata.HistoryData" + description: "in case of 24hr Current Data, at least 1 History Data.\r\n \ + \ In case of 15min Current Data, at least 16 History Data.\r\n\ + \ In case of <15min, the number of History Data shall be able\ + \ to cover a span of 4 hours." parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - name: "oam-service-uuid" + - name: "local-id" in: "path" - description: "Id of oam-service-end-point" + description: "Id of current-data" required: true type: "string" - - name: "oam-service-end-point-local-id" + - name: "history-data-local-id" in: "path" - description: "Id of oam-service-end-point" + description: "Id of history-data" required: true type: "string" responses: 200: - description: "tapi.oam.OamServiceEndPointRef" + description: "tapi.oam.currentdata.HistoryData" schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPointRef" + $ref: "#/definitions/tapi.oam.currentdata.HistoryData" 400: description: "Internal error" - post: + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-on-demand-1-dm-performance-data/ + : get: tags: - - "tapi-oam" - description: "creates tapi.oam.OamServiceEndPointRef" + - "tapi-eth" + summary: "returns tapi.eth.EthOnDemand1DmPerformanceData" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - name: "oam-service-uuid" + - name: "local-id" in: "path" - description: "Id of oam-service-end-point" + description: "Id of current-data" required: true type: "string" - - name: "oam-service-end-point-local-id" + - name: "history-data-local-id" in: "path" - description: "Id of oam-service-end-point" + description: "Id of history-data" required: true type: "string" - - in: "body" - name: "tapi.oam.OamServiceEndPointRef.body-param" - description: "tapi.oam.OamServiceEndPointRef to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPointRef" responses: - 201: - description: "Object created" + 200: + description: "tapi.eth.EthOnDemand1DmPerformanceData" + schema: + $ref: "#/definitions/tapi.eth.EthOnDemand1DmPerformanceData" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-on-demand-1-dm-performance-data/samples-near-end-1-dm-parameters/ + : get: tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamServiceEndPointRef" + - "tapi-eth" + summary: "returns tapi.eth.SamplesDmPerformanceParameters" + description: "This attribute contains the results of an on-demand frame delay\ + \ measurement job in the ingress direction." parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - name: "oam-service-uuid" + - name: "local-id" in: "path" - description: "Id of oam-service-end-point" + description: "Id of current-data" required: true type: "string" - - name: "oam-service-end-point-local-id" + - name: "history-data-local-id" in: "path" - description: "Id of oam-service-end-point" + description: "Id of history-data" required: true type: "string" - - in: "body" - name: "tapi.oam.OamServiceEndPointRef.body-param" - description: "tapi.oam.OamServiceEndPointRef to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPointRef" responses: - 201: - description: "Object created" + 200: + description: "tapi.eth.SamplesDmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.SamplesDmPerformanceParameters" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-on-demand-1-dm-performance-data/statistical-near-end-1-dm-parameters/ + : get: tags: - - "tapi-oam" - description: "removes tapi.oam.OamServiceEndPointRef" + - "tapi-eth" + summary: "returns tapi.eth.StatisticalDmPerformanceParameters" + description: "This attribute contains the statistical near end performnace parameters." parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - name: "oam-service-uuid" + - name: "local-id" in: "path" - description: "Id of oam-service-end-point" + description: "Id of current-data" required: true type: "string" - - name: "oam-service-end-point-local-id" + - name: "history-data-local-id" in: "path" - description: "Id of oam-service-end-point" + description: "Id of history-data" required: true type: "string" responses: + 200: + description: "tapi.eth.StatisticalDmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/: - get: + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-on-demand-1-dm-source-performance-data/ + : get: tags: - - "tapi-oam" - description: "returns tapi.oam.oamjob.PmCurrentData" + - "tapi-eth" + summary: "returns tapi.eth.EthOnDemand1DmSourcePerformanceData" + description: "none" parameters: - name: "uuid" in: "path" @@ -6649,21 +7436,27 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" required: true type: "string" responses: 200: - description: "tapi.oam.oamjob.PmCurrentData" + description: "tapi.eth.EthOnDemand1DmSourcePerformanceData" schema: - $ref: "#/definitions/tapi.oam.oamjob.PmCurrentData" + $ref: "#/definitions/tapi.eth.EthOnDemand1DmSourcePerformanceData" 400: description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/elapsed-time/: - get: + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-on-demand-1-lm-performance-data/ + : get: tags: - - "tapi-oam" - description: "returns tapi.common.TimeInterval" + - "tapi-eth" + summary: "returns tapi.eth.EthOnDemand1LmPerformanceData" + description: "none" parameters: - name: "uuid" in: "path" @@ -6672,21 +7465,27 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" required: true type: "string" responses: 200: - description: "tapi.common.TimeInterval" + description: "tapi.eth.EthOnDemand1LmPerformanceData" schema: - $ref: "#/definitions/tapi.common.TimeInterval" + $ref: "#/definitions/tapi.eth.EthOnDemand1LmPerformanceData" 400: description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/elapsed-time/period={unit}/: - get: + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-on-demand-1-lm-performance-data/statistical-near-end-1-lm-parameters/ + : get: tags: - - "tapi-oam" - description: "returns tapi.common.TimePeriod" + - "tapi-eth" + summary: "returns tapi.eth.StatisticalLmPerformanceParameters" + description: "This attribute contains the statistical near end performnace parameters." parameters: - name: "uuid" in: "path" @@ -6695,26 +7494,28 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" + description: "Id of current-data" required: true type: "string" - - name: "unit" + - name: "history-data-local-id" in: "path" - description: "Id of period" + description: "Id of history-data" required: true type: "string" responses: 200: - description: "tapi.common.TimePeriod" + description: "tapi.eth.StatisticalLmPerformanceParameters" schema: - $ref: "#/definitions/tapi.common.TimePeriod" + $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" 400: description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/eth-link-trace-result-data/: - get: + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-on-demand-1-lm-performance-data/total-counters-near-end-1-lm-parameters/ + : get: tags: - "tapi-eth" - description: "returns tapi.eth.EthLinkTraceResultData" + summary: "returns tapi.eth.TotalCountersLmPerformanceParameters" + description: "This attribute contains the results of an on-demand synthetic\ + \ loss measurement job in the ingress direction." parameters: - name: "uuid" in: "path" @@ -6723,21 +7524,27 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" required: true type: "string" responses: 200: - description: "tapi.eth.EthLinkTraceResultData" + description: "tapi.eth.TotalCountersLmPerformanceParameters" schema: - $ref: "#/definitions/tapi.eth.EthLinkTraceResultData" + $ref: "#/definitions/tapi.eth.TotalCountersLmPerformanceParameters" 400: description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/eth-link-trace-result-data/result-list={source-address}/: - get: + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-on-demand-1-lm-source-performance-data/ + : get: tags: - "tapi-eth" - description: "returns tapi.eth.LinkTraceResult" + summary: "returns tapi.eth.EthOnDemand1LmSourcePerformanceData" + description: "none" parameters: - name: "uuid" in: "path" @@ -6746,26 +7553,27 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" + description: "Id of current-data" required: true type: "string" - - name: "source-address" + - name: "history-data-local-id" in: "path" - description: "Id of result-list" + description: "Id of history-data" required: true type: "string" responses: 200: - description: "tapi.eth.LinkTraceResult" + description: "tapi.eth.EthOnDemand1LmSourcePerformanceData" schema: - $ref: "#/definitions/tapi.eth.LinkTraceResult" + $ref: "#/definitions/tapi.eth.EthOnDemand1LmSourcePerformanceData" 400: description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/eth-loopback-result-data/: - get: + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-on-demand-dm-performance-data/ + : get: tags: - "tapi-eth" - description: "returns tapi.eth.EthLoopbackResultData" + summary: "returns tapi.eth.EthOnDemandDmPerformanceData" + description: "none" parameters: - name: "uuid" in: "path" @@ -6774,21 +7582,28 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" required: true type: "string" responses: 200: - description: "tapi.eth.EthLoopbackResultData" + description: "tapi.eth.EthOnDemandDmPerformanceData" schema: - $ref: "#/definitions/tapi.eth.EthLoopbackResultData" + $ref: "#/definitions/tapi.eth.EthOnDemandDmPerformanceData" 400: description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/eth-on-demand-1-dm-performance-data/: - get: + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-on-demand-dm-performance-data/samples-far-end-dm-parameters/ + : get: tags: - "tapi-eth" - description: "returns tapi.eth.EthOnDemand1DmPerformanceData" + summary: "returns tapi.eth.SamplesDmPerformanceParameters" + description: "This attribute contains the results of an on-demand frame delay\ + \ measurement job in the ingress direction." parameters: - name: "uuid" in: "path" @@ -6797,21 +7612,28 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" required: true type: "string" responses: 200: - description: "tapi.eth.EthOnDemand1DmPerformanceData" + description: "tapi.eth.SamplesDmPerformanceParameters" schema: - $ref: "#/definitions/tapi.eth.EthOnDemand1DmPerformanceData" + $ref: "#/definitions/tapi.eth.SamplesDmPerformanceParameters" 400: description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/eth-on-demand-1-dm-performance-data/on-demand-near-end-1-dm-parameters/ + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-on-demand-dm-performance-data/samples-near-end-dm-parameters/ : get: tags: - "tapi-eth" - description: "returns tapi.eth.OnDemandDmPerformanceParameters" + summary: "returns tapi.eth.SamplesDmPerformanceParameters" + description: "This attribute contains the results of an on-demand frame delay\ + \ measurement job in the ingress direction." parameters: - name: "uuid" in: "path" @@ -6820,21 +7642,28 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" required: true type: "string" responses: 200: - description: "tapi.eth.OnDemandDmPerformanceParameters" + description: "tapi.eth.SamplesDmPerformanceParameters" schema: - $ref: "#/definitions/tapi.eth.OnDemandDmPerformanceParameters" + $ref: "#/definitions/tapi.eth.SamplesDmPerformanceParameters" 400: description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/eth-on-demand-1-lm-performance-data/: - get: + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-on-demand-dm-performance-data/statistical-bi-dir-dm-parameters/ + : get: tags: - "tapi-eth" - description: "returns tapi.eth.EthOnDemand1LmPerformanceData" + summary: "returns tapi.eth.StatisticalDmPerformanceParameters" + description: "This attribute contains the statistical bidirectional performnace\ + \ parameters." parameters: - name: "uuid" in: "path" @@ -6843,21 +7672,27 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" required: true type: "string" responses: 200: - description: "tapi.eth.EthOnDemand1LmPerformanceData" + description: "tapi.eth.StatisticalDmPerformanceParameters" schema: - $ref: "#/definitions/tapi.eth.EthOnDemand1LmPerformanceData" + $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" 400: description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/eth-on-demand-1-lm-performance-data/on-demand-near-end-1-lm-parameters/ + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-on-demand-dm-performance-data/statistical-far-end-dm-parameters/ : get: tags: - "tapi-eth" - description: "returns tapi.eth.OnDemandLmPerformanceParameters" + summary: "returns tapi.eth.StatisticalDmPerformanceParameters" + description: "This attribute contains the statistical far end performnace parameters." parameters: - name: "uuid" in: "path" @@ -6866,21 +7701,27 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" required: true type: "string" responses: 200: - description: "tapi.eth.OnDemandLmPerformanceParameters" + description: "tapi.eth.StatisticalDmPerformanceParameters" schema: - $ref: "#/definitions/tapi.eth.OnDemandLmPerformanceParameters" + $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" 400: description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/eth-on-demand-dm-performance-data/: - get: + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-on-demand-dm-performance-data/statistical-near-end-dm-parameters/ + : get: tags: - "tapi-eth" - description: "returns tapi.eth.EthOnDemandDmPerformanceData" + summary: "returns tapi.eth.StatisticalDmPerformanceParameters" + description: "This attribute contains the statistical near end performnace parameters." parameters: - name: "uuid" in: "path" @@ -6889,21 +7730,27 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" required: true type: "string" responses: 200: - description: "tapi.eth.EthOnDemandDmPerformanceData" + description: "tapi.eth.StatisticalDmPerformanceParameters" schema: - $ref: "#/definitions/tapi.eth.EthOnDemandDmPerformanceData" + $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" 400: description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/eth-on-demand-dm-performance-data/on-demand-far-end-dm-parameters/ + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-on-demand-lm-performance-data/ : get: tags: - "tapi-eth" - description: "returns tapi.eth.OnDemandDmPerformanceParameters" + summary: "returns tapi.eth.EthOnDemandLmPerformanceData" + description: "none" parameters: - name: "uuid" in: "path" @@ -6912,21 +7759,27 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" required: true type: "string" responses: 200: - description: "tapi.eth.OnDemandDmPerformanceParameters" + description: "tapi.eth.EthOnDemandLmPerformanceData" schema: - $ref: "#/definitions/tapi.eth.OnDemandDmPerformanceParameters" + $ref: "#/definitions/tapi.eth.EthOnDemandLmPerformanceData" 400: description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/eth-on-demand-dm-performance-data/on-demand-near-end-dm-parameters/ + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-on-demand-lm-performance-data/statistical-far-end-lm-parameters/ : get: tags: - "tapi-eth" - description: "returns tapi.eth.OnDemandDmPerformanceParameters" + summary: "returns tapi.eth.StatisticalLmPerformanceParameters" + description: "This attribute contains the statistical far end performnace parameters." parameters: - name: "uuid" in: "path" @@ -6935,21 +7788,27 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" required: true type: "string" responses: 200: - description: "tapi.eth.OnDemandDmPerformanceParameters" + description: "tapi.eth.StatisticalLmPerformanceParameters" schema: - $ref: "#/definitions/tapi.eth.OnDemandDmPerformanceParameters" + $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" 400: description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/eth-on-demand-lm-performance-data/: - get: + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-on-demand-lm-performance-data/statistical-near-end-lm-parameters/ + : get: tags: - "tapi-eth" - description: "returns tapi.eth.EthOnDemandLmPerformanceData" + summary: "returns tapi.eth.StatisticalLmPerformanceParameters" + description: "This attribute contains the statistical near end performnace parameters." parameters: - name: "uuid" in: "path" @@ -6958,21 +7817,28 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" required: true type: "string" responses: 200: - description: "tapi.eth.EthOnDemandLmPerformanceData" + description: "tapi.eth.StatisticalLmPerformanceParameters" schema: - $ref: "#/definitions/tapi.eth.EthOnDemandLmPerformanceData" + $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" 400: description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/eth-on-demand-lm-performance-data/on-demand-far-end-lm-parameters/ + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-on-demand-lm-performance-data/total-counters-far-end-lm-parameters/ : get: tags: - "tapi-eth" - description: "returns tapi.eth.OnDemandLmPerformanceParameters" + summary: "returns tapi.eth.TotalCountersLmPerformanceParameters" + description: "This attribute contains the results of an on-demand synthetic\ + \ loss measurement job in the egress direction." parameters: - name: "uuid" in: "path" @@ -6981,21 +7847,28 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" required: true type: "string" responses: 200: - description: "tapi.eth.OnDemandLmPerformanceParameters" + description: "tapi.eth.TotalCountersLmPerformanceParameters" schema: - $ref: "#/definitions/tapi.eth.OnDemandLmPerformanceParameters" + $ref: "#/definitions/tapi.eth.TotalCountersLmPerformanceParameters" 400: description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/eth-on-demand-lm-performance-data/on-demand-near-end-lm-parameters/ + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-on-demand-lm-performance-data/total-counters-near-end-lm-parameters/ : get: tags: - "tapi-eth" - description: "returns tapi.eth.OnDemandLmPerformanceParameters" + summary: "returns tapi.eth.TotalCountersLmPerformanceParameters" + description: "This attribute contains the results of an on-demand synthetic\ + \ loss measurement job in the ingress direction." parameters: - name: "uuid" in: "path" @@ -7004,44 +7877,27 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.OnDemandLmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.OnDemandLmPerformanceParameters" - 400: - description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/eth-pro-active-1-dm-performance-data/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EthProActive1DmPerformanceData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" + description: "Id of current-data" required: true type: "string" - - name: "local-id" + - name: "history-data-local-id" in: "path" - description: "Id of pm-current-data" + description: "Id of history-data" required: true type: "string" responses: 200: - description: "tapi.eth.EthProActive1DmPerformanceData" + description: "tapi.eth.TotalCountersLmPerformanceParameters" schema: - $ref: "#/definitions/tapi.eth.EthProActive1DmPerformanceData" + $ref: "#/definitions/tapi.eth.TotalCountersLmPerformanceParameters" 400: description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/eth-pro-active-1-dm-performance-data/pro-active-near-end-1-dm-parameters/ + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-pro-active-1-dm-performance-data/ : get: tags: - "tapi-eth" - description: "returns tapi.eth.StatisticalDmPerformanceParameters" + summary: "returns tapi.eth.EthProActive1DmPerformanceData" + description: "none" parameters: - name: "uuid" in: "path" @@ -7050,44 +7906,27 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.StatisticalDmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - 400: - description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/eth-pro-active-1-lm-performance-data/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EthProActive1LmPerformanceData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" + description: "Id of current-data" required: true type: "string" - - name: "local-id" + - name: "history-data-local-id" in: "path" - description: "Id of pm-current-data" + description: "Id of history-data" required: true type: "string" responses: 200: - description: "tapi.eth.EthProActive1LmPerformanceData" + description: "tapi.eth.EthProActive1DmPerformanceData" schema: - $ref: "#/definitions/tapi.eth.EthProActive1LmPerformanceData" + $ref: "#/definitions/tapi.eth.EthProActive1DmPerformanceData" 400: description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/eth-pro-active-1-lm-performance-data/pro-active-near-end-1-lm-parameters/ + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-pro-active-1-dm-performance-data/statistical-near-end-1-dm-parameters/ : get: tags: - "tapi-eth" - description: "returns tapi.eth.StatisticalLmPerformanceParameters" + summary: "returns tapi.eth.StatisticalDmPerformanceParameters" + description: "This attribute contains the statistical near end performnace parameters." parameters: - name: "uuid" in: "path" @@ -7096,44 +7935,27 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.StatisticalLmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" - 400: - description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/eth-pro-active-dm-performance-data/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EthProActiveDmPerformanceData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" + description: "Id of current-data" required: true type: "string" - - name: "local-id" + - name: "history-data-local-id" in: "path" - description: "Id of pm-current-data" + description: "Id of history-data" required: true type: "string" responses: 200: - description: "tapi.eth.EthProActiveDmPerformanceData" + description: "tapi.eth.StatisticalDmPerformanceParameters" schema: - $ref: "#/definitions/tapi.eth.EthProActiveDmPerformanceData" + $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" 400: description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/eth-pro-active-dm-performance-data/pro-active-bi-dir-dm-parameters/ + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-pro-active-1-dm-source-performance-data/ : get: tags: - "tapi-eth" - description: "returns tapi.eth.StatisticalDmPerformanceParameters" + summary: "returns tapi.eth.EthProActive1DmSourcePerformanceData" + description: "none" parameters: - name: "uuid" in: "path" @@ -7142,44 +7964,27 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.StatisticalDmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - 400: - description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/eth-pro-active-dm-performance-data/pro-active-far-end-dm-parameters/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.StatisticalDmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" + description: "Id of current-data" required: true type: "string" - - name: "local-id" + - name: "history-data-local-id" in: "path" - description: "Id of pm-current-data" + description: "Id of history-data" required: true type: "string" responses: 200: - description: "tapi.eth.StatisticalDmPerformanceParameters" + description: "tapi.eth.EthProActive1DmSourcePerformanceData" schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + $ref: "#/definitions/tapi.eth.EthProActive1DmSourcePerformanceData" 400: description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/eth-pro-active-dm-performance-data/pro-active-near-end-dm-parameters/ + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-pro-active-1-lm-performance-data/ : get: tags: - "tapi-eth" - description: "returns tapi.eth.StatisticalDmPerformanceParameters" + summary: "returns tapi.eth.EthProActive1LmPerformanceData" + description: "none" parameters: - name: "uuid" in: "path" @@ -7188,44 +7993,27 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.StatisticalDmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - 400: - description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/eth-pro-active-lm-performance-data/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EthProActiveLmPerformanceData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" + description: "Id of current-data" required: true type: "string" - - name: "local-id" + - name: "history-data-local-id" in: "path" - description: "Id of pm-current-data" + description: "Id of history-data" required: true type: "string" responses: 200: - description: "tapi.eth.EthProActiveLmPerformanceData" + description: "tapi.eth.EthProActive1LmPerformanceData" schema: - $ref: "#/definitions/tapi.eth.EthProActiveLmPerformanceData" + $ref: "#/definitions/tapi.eth.EthProActive1LmPerformanceData" 400: description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/eth-pro-active-lm-performance-data/pro-active-far-end-lm-parameters/ + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-pro-active-1-lm-performance-data/statistical-near-end-1-lm-parameters/ : get: tags: - "tapi-eth" - description: "returns tapi.eth.StatisticalLmPerformanceParameters" + summary: "returns tapi.eth.StatisticalLmPerformanceParameters" + description: "This attribute contains the statistical near end performnace parameters." parameters: - name: "uuid" in: "path" @@ -7234,30 +8022,12 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.StatisticalLmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" - 400: - description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/eth-pro-active-lm-performance-data/pro-active-near-end-lm-parameters/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.StatisticalLmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" + description: "Id of current-data" required: true type: "string" - - name: "local-id" + - name: "history-data-local-id" in: "path" - description: "Id of pm-current-data" + description: "Id of history-data" required: true type: "string" responses: @@ -7267,11 +8037,13 @@ paths: $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" 400: description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/eth-test-result-data/: - get: + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-pro-active-1-lm-performance-data/total-counters-near-end-1-lm-parameters/ + : get: tags: - "tapi-eth" - description: "returns tapi.eth.EthTestResultData" + summary: "returns tapi.eth.TotalCountersLmPerformanceParameters" + description: "This attribute contains the results of an on-demand synthetic\ + \ loss measurement job in the ingress direction." parameters: - name: "uuid" in: "path" @@ -7280,44 +8052,27 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.EthTestResultData" - schema: - $ref: "#/definitions/tapi.eth.EthTestResultData" - 400: - description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/granularity-period/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" + description: "Id of current-data" required: true type: "string" - - name: "local-id" + - name: "history-data-local-id" in: "path" - description: "Id of pm-current-data" + description: "Id of history-data" required: true type: "string" responses: 200: - description: "tapi.common.TimePeriod" + description: "tapi.eth.TotalCountersLmPerformanceParameters" schema: - $ref: "#/definitions/tapi.common.TimePeriod" + $ref: "#/definitions/tapi.eth.TotalCountersLmPerformanceParameters" 400: description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/name={value-name}/: - get: + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-pro-active-1-lm-source-performance-data/ + : get: tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" + - "tapi-eth" + summary: "returns tapi.eth.EthProActive1LmSourcePerformanceData" + description: "none" parameters: - name: "uuid" in: "path" @@ -7326,26 +8081,27 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" + description: "Id of current-data" required: true type: "string" - - name: "value-name" + - name: "history-data-local-id" in: "path" - description: "Id of name" + description: "Id of history-data" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.eth.EthProActive1LmSourcePerformanceData" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.eth.EthProActive1LmSourcePerformanceData" 400: description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/: - get: + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-pro-active-dm-performance-data/ + : get: tags: - - "tapi-oam" - description: "returns tapi.oam.pmcurrentdata.PmHistoryData" + - "tapi-eth" + summary: "returns tapi.eth.EthProActiveDmPerformanceData" + description: "none" parameters: - name: "uuid" in: "path" @@ -7354,26 +8110,28 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" + description: "Id of current-data" required: true type: "string" - - name: "pm-history-data-local-id" + - name: "history-data-local-id" in: "path" - description: "Id of pm-history-data" + description: "Id of history-data" required: true type: "string" responses: 200: - description: "tapi.oam.pmcurrentdata.PmHistoryData" + description: "tapi.eth.EthProActiveDmPerformanceData" schema: - $ref: "#/definitions/tapi.oam.pmcurrentdata.PmHistoryData" + $ref: "#/definitions/tapi.eth.EthProActiveDmPerformanceData" 400: description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/eth-on-demand-1-dm-performance-data/ + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-pro-active-dm-performance-data/statistical-bi-dir-dm-parameters/ : get: tags: - "tapi-eth" - description: "returns tapi.eth.EthOnDemand1DmPerformanceData" + summary: "returns tapi.eth.StatisticalDmPerformanceParameters" + description: "This attribute contains the statistical bidirectional performnace\ + \ parameters." parameters: - name: "uuid" in: "path" @@ -7382,26 +8140,27 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" + description: "Id of current-data" required: true type: "string" - - name: "pm-history-data-local-id" + - name: "history-data-local-id" in: "path" - description: "Id of pm-history-data" + description: "Id of history-data" required: true type: "string" responses: 200: - description: "tapi.eth.EthOnDemand1DmPerformanceData" + description: "tapi.eth.StatisticalDmPerformanceParameters" schema: - $ref: "#/definitions/tapi.eth.EthOnDemand1DmPerformanceData" + $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" 400: description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/eth-on-demand-1-dm-performance-data/on-demand-near-end-1-dm-parameters/ + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-pro-active-dm-performance-data/statistical-far-end-dm-parameters/ : get: tags: - "tapi-eth" - description: "returns tapi.eth.OnDemandDmPerformanceParameters" + summary: "returns tapi.eth.StatisticalDmPerformanceParameters" + description: "This attribute contains the statistical far end performnace parameters." parameters: - name: "uuid" in: "path" @@ -7410,26 +8169,27 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" + description: "Id of current-data" required: true type: "string" - - name: "pm-history-data-local-id" + - name: "history-data-local-id" in: "path" - description: "Id of pm-history-data" + description: "Id of history-data" required: true type: "string" responses: 200: - description: "tapi.eth.OnDemandDmPerformanceParameters" + description: "tapi.eth.StatisticalDmPerformanceParameters" schema: - $ref: "#/definitions/tapi.eth.OnDemandDmPerformanceParameters" + $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" 400: description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/eth-on-demand-1-lm-performance-data/ + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-pro-active-dm-performance-data/statistical-near-end-dm-parameters/ : get: tags: - "tapi-eth" - description: "returns tapi.eth.EthOnDemand1LmPerformanceData" + summary: "returns tapi.eth.StatisticalDmPerformanceParameters" + description: "This attribute contains the statistical near end performnace parameters." parameters: - name: "uuid" in: "path" @@ -7438,26 +8198,27 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" + description: "Id of current-data" required: true type: "string" - - name: "pm-history-data-local-id" + - name: "history-data-local-id" in: "path" - description: "Id of pm-history-data" + description: "Id of history-data" required: true type: "string" responses: 200: - description: "tapi.eth.EthOnDemand1LmPerformanceData" + description: "tapi.eth.StatisticalDmPerformanceParameters" schema: - $ref: "#/definitions/tapi.eth.EthOnDemand1LmPerformanceData" + $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" 400: description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/eth-on-demand-1-lm-performance-data/on-demand-near-end-1-lm-parameters/ + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-pro-active-lm-performance-data/ : get: tags: - "tapi-eth" - description: "returns tapi.eth.OnDemandLmPerformanceParameters" + summary: "returns tapi.eth.EthProActiveLmPerformanceData" + description: "none" parameters: - name: "uuid" in: "path" @@ -7466,26 +8227,27 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" + description: "Id of current-data" required: true type: "string" - - name: "pm-history-data-local-id" + - name: "history-data-local-id" in: "path" - description: "Id of pm-history-data" + description: "Id of history-data" required: true type: "string" responses: 200: - description: "tapi.eth.OnDemandLmPerformanceParameters" + description: "tapi.eth.EthProActiveLmPerformanceData" schema: - $ref: "#/definitions/tapi.eth.OnDemandLmPerformanceParameters" + $ref: "#/definitions/tapi.eth.EthProActiveLmPerformanceData" 400: description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/eth-on-demand-dm-performance-data/ + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-pro-active-lm-performance-data/statistical-far-end-lm-parameters/ : get: tags: - "tapi-eth" - description: "returns tapi.eth.EthOnDemandDmPerformanceData" + summary: "returns tapi.eth.StatisticalLmPerformanceParameters" + description: "This attribute contains the statistical far end performnace parameters." parameters: - name: "uuid" in: "path" @@ -7494,26 +8256,27 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" + description: "Id of current-data" required: true type: "string" - - name: "pm-history-data-local-id" + - name: "history-data-local-id" in: "path" - description: "Id of pm-history-data" + description: "Id of history-data" required: true type: "string" responses: 200: - description: "tapi.eth.EthOnDemandDmPerformanceData" + description: "tapi.eth.StatisticalLmPerformanceParameters" schema: - $ref: "#/definitions/tapi.eth.EthOnDemandDmPerformanceData" + $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" 400: description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/eth-on-demand-dm-performance-data/on-demand-far-end-dm-parameters/ + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-pro-active-lm-performance-data/statistical-near-end-lm-parameters/ : get: tags: - "tapi-eth" - description: "returns tapi.eth.OnDemandDmPerformanceParameters" + summary: "returns tapi.eth.StatisticalLmPerformanceParameters" + description: "This attribute contains the statistical near end performnace parameters." parameters: - name: "uuid" in: "path" @@ -7522,26 +8285,28 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" + description: "Id of current-data" required: true type: "string" - - name: "pm-history-data-local-id" + - name: "history-data-local-id" in: "path" - description: "Id of pm-history-data" + description: "Id of history-data" required: true type: "string" responses: 200: - description: "tapi.eth.OnDemandDmPerformanceParameters" + description: "tapi.eth.StatisticalLmPerformanceParameters" schema: - $ref: "#/definitions/tapi.eth.OnDemandDmPerformanceParameters" + $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" 400: description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/eth-on-demand-dm-performance-data/on-demand-near-end-dm-parameters/ + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-pro-active-lm-performance-data/total-counters-far-end-lm-parameters/ : get: tags: - "tapi-eth" - description: "returns tapi.eth.OnDemandDmPerformanceParameters" + summary: "returns tapi.eth.TotalCountersLmPerformanceParameters" + description: "This attribute contains the results of an on-demand synthetic\ + \ loss measurement job in the egress direction." parameters: - name: "uuid" in: "path" @@ -7550,26 +8315,28 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" + description: "Id of current-data" required: true type: "string" - - name: "pm-history-data-local-id" + - name: "history-data-local-id" in: "path" - description: "Id of pm-history-data" + description: "Id of history-data" required: true type: "string" responses: 200: - description: "tapi.eth.OnDemandDmPerformanceParameters" + description: "tapi.eth.TotalCountersLmPerformanceParameters" schema: - $ref: "#/definitions/tapi.eth.OnDemandDmPerformanceParameters" + $ref: "#/definitions/tapi.eth.TotalCountersLmPerformanceParameters" 400: description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/eth-on-demand-lm-performance-data/ + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-pro-active-lm-performance-data/total-counters-near-end-lm-parameters/ : get: tags: - "tapi-eth" - description: "returns tapi.eth.EthOnDemandLmPerformanceData" + summary: "returns tapi.eth.TotalCountersLmPerformanceParameters" + description: "This attribute contains the results of an on-demand synthetic\ + \ loss measurement job in the ingress direction." parameters: - name: "uuid" in: "path" @@ -7578,26 +8345,29 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" + description: "Id of current-data" required: true type: "string" - - name: "pm-history-data-local-id" + - name: "history-data-local-id" in: "path" - description: "Id of pm-history-data" + description: "Id of history-data" required: true type: "string" responses: 200: - description: "tapi.eth.EthOnDemandLmPerformanceData" + description: "tapi.eth.TotalCountersLmPerformanceParameters" schema: - $ref: "#/definitions/tapi.eth.EthOnDemandLmPerformanceData" + $ref: "#/definitions/tapi.eth.TotalCountersLmPerformanceParameters" 400: description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/eth-on-demand-lm-performance-data/on-demand-far-end-lm-parameters/ - : get: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/name={value-name}/: + get: tags: - - "tapi-eth" - description: "returns tapi.eth.OnDemandLmPerformanceParameters" + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -7606,26 +8376,32 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" required: true type: "string" - - name: "pm-history-data-local-id" + - name: "value-name" in: "path" - description: "Id of pm-history-data" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.eth.OnDemandLmPerformanceParameters" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.eth.OnDemandLmPerformanceParameters" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/eth-on-demand-lm-performance-data/on-demand-near-end-lm-parameters/ - : get: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/pm-data-pac/: + get: tags: - - "tapi-eth" - description: "returns tapi.eth.OnDemandLmPerformanceParameters" + - "tapi-oam" + summary: "returns tapi.oam.PmDataPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -7634,26 +8410,27 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" + description: "Id of current-data" required: true type: "string" - - name: "pm-history-data-local-id" + - name: "history-data-local-id" in: "path" - description: "Id of pm-history-data" + description: "Id of history-data" required: true type: "string" responses: 200: - description: "tapi.eth.OnDemandLmPerformanceParameters" + description: "tapi.oam.PmDataPac" schema: - $ref: "#/definitions/tapi.eth.OnDemandLmPerformanceParameters" + $ref: "#/definitions/tapi.oam.PmDataPac" 400: description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/eth-pro-active-1-dm-performance-data/ + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/pm-data-pac/granularity-period/ : get: tags: - - "tapi-eth" - description: "returns tapi.eth.EthProActive1DmPerformanceData" + - "tapi-oam" + summary: "returns tapi.common.TimePeriod" + description: "none" parameters: - name: "uuid" in: "path" @@ -7662,26 +8439,29 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" + description: "Id of current-data" required: true type: "string" - - name: "pm-history-data-local-id" + - name: "history-data-local-id" in: "path" - description: "Id of pm-history-data" + description: "Id of history-data" required: true type: "string" responses: 200: - description: "tapi.eth.EthProActive1DmPerformanceData" + description: "tapi.common.TimePeriod" schema: - $ref: "#/definitions/tapi.eth.EthProActive1DmPerformanceData" + $ref: "#/definitions/tapi.common.TimePeriod" 400: description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/eth-pro-active-1-dm-performance-data/pro-active-near-end-1-dm-parameters/ - : get: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/name={value-name}/: + get: tags: - - "tapi-eth" - description: "returns tapi.eth.StatisticalDmPerformanceParameters" + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -7690,26 +8470,27 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" + description: "Id of current-data" required: true type: "string" - - name: "pm-history-data-local-id" + - name: "value-name" in: "path" - description: "Id of pm-history-data" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.eth.StatisticalDmPerformanceParameters" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/eth-pro-active-1-lm-performance-data/ - : get: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/pm-data-pac/: + get: tags: - - "tapi-eth" - description: "returns tapi.eth.EthProActive1LmPerformanceData" + - "tapi-oam" + summary: "returns tapi.oam.PmDataPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -7718,26 +8499,22 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" - in: "path" - description: "Id of pm-history-data" + description: "Id of current-data" required: true type: "string" responses: 200: - description: "tapi.eth.EthProActive1LmPerformanceData" + description: "tapi.oam.PmDataPac" schema: - $ref: "#/definitions/tapi.eth.EthProActive1LmPerformanceData" + $ref: "#/definitions/tapi.oam.PmDataPac" 400: description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/eth-pro-active-1-lm-performance-data/pro-active-near-end-1-lm-parameters/ - : get: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/pm-data-pac/granularity-period/: + get: tags: - - "tapi-eth" - description: "returns tapi.eth.StatisticalLmPerformanceParameters" + - "tapi-oam" + summary: "returns tapi.common.TimePeriod" + description: "none" parameters: - name: "uuid" in: "path" @@ -7746,283 +8523,271 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" - in: "path" - description: "Id of pm-history-data" + description: "Id of current-data" required: true type: "string" responses: 200: - description: "tapi.eth.StatisticalLmPerformanceParameters" + description: "tapi.common.TimePeriod" schema: - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" + $ref: "#/definitions/tapi.common.TimePeriod" 400: description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/eth-pro-active-dm-performance-data/ - : get: + /data/context/oam-context/oam-job={uuid}/eth-link-trace-job/: + get: tags: - "tapi-eth" - description: "returns tapi.eth.EthProActiveDmPerformanceData" + summary: "returns tapi.eth.EthLinkTraceJob" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" - in: "path" - description: "Id of pm-history-data" - required: true - type: "string" responses: 200: - description: "tapi.eth.EthProActiveDmPerformanceData" + description: "tapi.eth.EthLinkTraceJob" schema: - $ref: "#/definitions/tapi.eth.EthProActiveDmPerformanceData" + $ref: "#/definitions/tapi.eth.EthLinkTraceJob" 400: description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/eth-pro-active-dm-performance-data/pro-active-bi-dir-dm-parameters/ - : get: + post: tags: - "tapi-eth" - description: "returns tapi.eth.StatisticalDmPerformanceParameters" + summary: "creates tapi.eth.EthLinkTraceJob" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" - in: "path" - description: "Id of pm-history-data" - required: true - type: "string" + - in: "body" + name: "tapi.eth.EthLinkTraceJob.body-param" + description: "tapi.eth.EthLinkTraceJob to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthLinkTraceJob" responses: - 200: - description: "tapi.eth.StatisticalDmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + 201: + description: "Object created" 400: description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/eth-pro-active-dm-performance-data/pro-active-far-end-dm-parameters/ - : get: + 409: + description: "Object already exists" + put: tags: - "tapi-eth" - description: "returns tapi.eth.StatisticalDmPerformanceParameters" + summary: "creates or updates tapi.eth.EthLinkTraceJob" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" - in: "path" - description: "Id of pm-history-data" - required: true - type: "string" + - in: "body" + name: "tapi.eth.EthLinkTraceJob.body-param" + description: "tapi.eth.EthLinkTraceJob to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthLinkTraceJob" responses: - 200: - description: "tapi.eth.StatisticalDmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + 201: + description: "Object created" 400: description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/eth-pro-active-dm-performance-data/pro-active-near-end-dm-parameters/ - : get: + 204: + description: "Object modified" + delete: tags: - "tapi-eth" - description: "returns tapi.eth.StatisticalDmPerformanceParameters" + summary: "removes tapi.eth.EthLinkTraceJob" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" - in: "path" - description: "Id of pm-history-data" - required: true - type: "string" responses: - 200: - description: "tapi.eth.StatisticalDmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" 400: description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/eth-pro-active-lm-performance-data/ - : get: + 204: + description: "Object deleted" + /data/context/oam-context/oam-job={uuid}/eth-link-trace-job/eth-cfm-link-trace-pac/: + get: tags: - "tapi-eth" - description: "returns tapi.eth.EthProActiveLmPerformanceData" + summary: "returns tapi.eth.EthCfmLinkTracePac" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" - in: "path" - description: "Id of pm-history-data" - required: true - type: "string" responses: 200: - description: "tapi.eth.EthProActiveLmPerformanceData" + description: "tapi.eth.EthCfmLinkTracePac" schema: - $ref: "#/definitions/tapi.eth.EthProActiveLmPerformanceData" + $ref: "#/definitions/tapi.eth.EthCfmLinkTracePac" 400: description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/eth-pro-active-lm-performance-data/pro-active-far-end-lm-parameters/ - : get: + post: tags: - "tapi-eth" - description: "returns tapi.eth.StatisticalLmPerformanceParameters" + summary: "creates tapi.eth.EthCfmLinkTracePac" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" - in: "path" - description: "Id of pm-history-data" - required: true - type: "string" + - in: "body" + name: "tapi.eth.EthCfmLinkTracePac.body-param" + description: "tapi.eth.EthCfmLinkTracePac to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthCfmLinkTracePac" responses: - 200: - description: "tapi.eth.StatisticalLmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" + 201: + description: "Object created" 400: description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/eth-pro-active-lm-performance-data/pro-active-near-end-lm-parameters/ - : get: + 409: + description: "Object already exists" + put: tags: - "tapi-eth" - description: "returns tapi.eth.StatisticalLmPerformanceParameters" + summary: "creates or updates tapi.eth.EthCfmLinkTracePac" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" - in: "path" - description: "Id of pm-history-data" - required: true - type: "string" + - in: "body" + name: "tapi.eth.EthCfmLinkTracePac.body-param" + description: "tapi.eth.EthCfmLinkTracePac to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthCfmLinkTracePac" responses: - 200: - description: "tapi.eth.StatisticalLmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" + 201: + description: "Object created" 400: description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/granularity-period/ - : get: + 204: + description: "Object modified" + delete: tags: - - "tapi-oam" - description: "returns tapi.common.TimePeriod" + - "tapi-eth" + summary: "removes tapi.eth.EthCfmLinkTracePac" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-job={uuid}/eth-loopback-job/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthLoopbackJob" + description: "none" + parameters: + - name: "uuid" in: "path" - description: "Id of pm-history-data" + description: "Id of oam-job" required: true type: "string" responses: 200: - description: "tapi.common.TimePeriod" + description: "tapi.eth.EthLoopbackJob" schema: - $ref: "#/definitions/tapi.common.TimePeriod" + $ref: "#/definitions/tapi.eth.EthLoopbackJob" 400: description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/name={value-name}/ - : get: + post: tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" + - "tapi-eth" + summary: "creates tapi.eth.EthLoopbackJob" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" + - in: "body" + name: "tapi.eth.EthLoopbackJob.body-param" + description: "tapi.eth.EthLoopbackJob to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthLoopbackJob" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-eth" + summary: "creates or updates tapi.eth.EthLoopbackJob" + description: "none" + parameters: + - name: "uuid" in: "path" - description: "Id of pm-history-data" + description: "Id of oam-job" required: true type: "string" - - name: "value-name" + - in: "body" + name: "tapi.eth.EthLoopbackJob.body-param" + description: "tapi.eth.EthLoopbackJob to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthLoopbackJob" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-eth" + summary: "removes tapi.eth.EthLoopbackJob" + description: "none" + parameters: + - name: "uuid" in: "path" - description: "Id of name" + description: "Id of oam-job" required: true type: "string" responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/oam-context/oam-job={uuid}/schedule/: + 204: + description: "Object deleted" + /data/context/oam-context/oam-job={uuid}/eth-loopback-job/eth-oam-test-loopback-common-pac/: get: tags: - - "tapi-oam" - description: "returns tapi.common.TimeRange" + - "tapi-eth" + summary: "returns tapi.eth.EthOamTestLoopbackCommonPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -8031,15 +8796,16 @@ paths: type: "string" responses: 200: - description: "tapi.common.TimeRange" + description: "tapi.eth.EthOamTestLoopbackCommonPac" schema: - $ref: "#/definitions/tapi.common.TimeRange" + $ref: "#/definitions/tapi.eth.EthOamTestLoopbackCommonPac" 400: description: "Internal error" post: tags: - - "tapi-oam" - description: "creates tapi.common.TimeRange" + - "tapi-eth" + summary: "creates tapi.eth.EthOamTestLoopbackCommonPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -8047,11 +8813,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.TimeRange.body-param" - description: "tapi.common.TimeRange to be added to list" + name: "tapi.eth.EthOamTestLoopbackCommonPac.body-param" + description: "tapi.eth.EthOamTestLoopbackCommonPac to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.TimeRange" + $ref: "#/definitions/tapi.eth.EthOamTestLoopbackCommonPac" responses: 201: description: "Object created" @@ -8061,8 +8827,9 @@ paths: description: "Object already exists" put: tags: - - "tapi-oam" - description: "creates or updates tapi.common.TimeRange" + - "tapi-eth" + summary: "creates or updates tapi.eth.EthOamTestLoopbackCommonPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -8070,11 +8837,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.TimeRange.body-param" - description: "tapi.common.TimeRange to be added or updated" + name: "tapi.eth.EthOamTestLoopbackCommonPac.body-param" + description: "tapi.eth.EthOamTestLoopbackCommonPac to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.TimeRange" + $ref: "#/definitions/tapi.eth.EthOamTestLoopbackCommonPac" responses: 201: description: "Object created" @@ -8084,8 +8851,9 @@ paths: description: "Object modified" delete: tags: - - "tapi-oam" - description: "removes tapi.common.TimeRange" + - "tapi-eth" + summary: "removes tapi.eth.EthOamTestLoopbackCommonPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -8097,59 +8865,42 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-profile/: - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.oamcontext.OamProfile" - parameters: - - in: "body" - name: "tapi.oam.oamcontext.OamProfile.body-param" - description: "tapi.oam.oamcontext.OamProfile to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.oamcontext.OamProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/: + /data/context/oam-context/oam-job={uuid}/eth-on-demand-dual-ended-measurement-job/: get: tags: - - "tapi-oam" - description: "returns tapi.oam.oamcontext.OamProfile" + - "tapi-eth" + summary: "returns tapi.eth.EthOnDemandDualEndedMeasurementJob" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-job" required: true type: "string" responses: 200: - description: "tapi.oam.oamcontext.OamProfile" + description: "tapi.eth.EthOnDemandDualEndedMeasurementJob" schema: - $ref: "#/definitions/tapi.oam.oamcontext.OamProfile" + $ref: "#/definitions/tapi.eth.EthOnDemandDualEndedMeasurementJob" 400: description: "Internal error" post: tags: - - "tapi-oam" - description: "creates tapi.oam.oamcontext.OamProfile" + - "tapi-eth" + summary: "creates tapi.eth.EthOnDemandDualEndedMeasurementJob" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-job" required: true type: "string" - in: "body" - name: "tapi.oam.oamcontext.OamProfile.body-param" - description: "tapi.oam.oamcontext.OamProfile to be added to list" + name: "tapi.eth.EthOnDemandDualEndedMeasurementJob.body-param" + description: "tapi.eth.EthOnDemandDualEndedMeasurementJob to be added to list" required: false schema: - $ref: "#/definitions/tapi.oam.oamcontext.OamProfile" + $ref: "#/definitions/tapi.eth.EthOnDemandDualEndedMeasurementJob" responses: 201: description: "Object created" @@ -8159,20 +8910,21 @@ paths: description: "Object already exists" put: tags: - - "tapi-oam" - description: "creates or updates tapi.oam.oamcontext.OamProfile" + - "tapi-eth" + summary: "creates or updates tapi.eth.EthOnDemandDualEndedMeasurementJob" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-job" required: true type: "string" - in: "body" - name: "tapi.oam.oamcontext.OamProfile.body-param" - description: "tapi.oam.oamcontext.OamProfile to be added or updated" + name: "tapi.eth.EthOnDemandDualEndedMeasurementJob.body-param" + description: "tapi.eth.EthOnDemandDualEndedMeasurementJob to be added or updated" required: false schema: - $ref: "#/definitions/tapi.oam.oamcontext.OamProfile" + $ref: "#/definitions/tapi.eth.EthOnDemandDualEndedMeasurementJob" responses: 201: description: "Object created" @@ -8182,12 +8934,13 @@ paths: description: "Object modified" delete: tags: - - "tapi-oam" - description: "removes tapi.oam.oamcontext.OamProfile" + - "tapi-eth" + summary: "removes tapi.eth.EthOnDemandDualEndedMeasurementJob" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-job" required: true type: "string" responses: @@ -8195,74 +8948,43 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/name/: - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/name={value-name}/: + /data/context/oam-context/oam-job={uuid}/eth-on-demand-dual-ended-measurement-job/eth-on-demand-measurement-job-control-sink/: get: tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" + - "tapi-eth" + summary: "returns tapi.eth.EthOnDemandMeasurementJobControlSink" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of oam-job" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.eth.EthOnDemandMeasurementJobControlSink" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.eth.EthOnDemandMeasurementJobControlSink" 400: description: "Internal error" post: tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" + - "tapi-eth" + summary: "creates tapi.eth.EthOnDemandMeasurementJobControlSink" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of oam-job" required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.eth.EthOnDemandMeasurementJobControlSink.body-param" + description: "tapi.eth.EthOnDemandMeasurementJobControlSink to be added to\ + \ list" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.eth.EthOnDemandMeasurementJobControlSink" responses: 201: description: "Object created" @@ -8272,25 +8994,22 @@ paths: description: "Object already exists" put: tags: - - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" + - "tapi-eth" + summary: "creates or updates tapi.eth.EthOnDemandMeasurementJobControlSink" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of oam-job" required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" + name: "tapi.eth.EthOnDemandMeasurementJobControlSink.body-param" + description: "tapi.eth.EthOnDemandMeasurementJobControlSink to be added or\ + \ updated" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.eth.EthOnDemandMeasurementJobControlSink" responses: 201: description: "Object created" @@ -8300,17 +9019,13 @@ paths: description: "Object modified" delete: tags: - - "tapi-oam" - description: "removes tapi.common.NameAndValue" + - "tapi-eth" + summary: "removes tapi.eth.EthOnDemandMeasurementJobControlSink" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of oam-job" required: true type: "string" responses: @@ -8318,74 +9033,43 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-bin-data/: - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.PmBinData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - in: "body" - name: "tapi.oam.PmBinData.body-param" - description: "tapi.oam.PmBinData to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.PmBinData" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/pm-bin-data={local-id}/: + /data/context/oam-context/oam-job={uuid}/eth-on-demand-dual-ended-measurement-job/eth-on-demand-measurement-job-control-source/: get: tags: - - "tapi-oam" - description: "returns tapi.oam.PmBinData" + - "tapi-eth" + summary: "returns tapi.eth.EthOnDemandMeasurementJobControlSource" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" + description: "Id of oam-job" required: true type: "string" responses: 200: - description: "tapi.oam.PmBinData" + description: "tapi.eth.EthOnDemandMeasurementJobControlSource" schema: - $ref: "#/definitions/tapi.oam.PmBinData" + $ref: "#/definitions/tapi.eth.EthOnDemandMeasurementJobControlSource" 400: description: "Internal error" post: tags: - - "tapi-oam" - description: "creates tapi.oam.PmBinData" + - "tapi-eth" + summary: "creates tapi.eth.EthOnDemandMeasurementJobControlSource" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" + description: "Id of oam-job" required: true type: "string" - in: "body" - name: "tapi.oam.PmBinData.body-param" - description: "tapi.oam.PmBinData to be added to list" + name: "tapi.eth.EthOnDemandMeasurementJobControlSource.body-param" + description: "tapi.eth.EthOnDemandMeasurementJobControlSource to be added\ + \ to list" required: false schema: - $ref: "#/definitions/tapi.oam.PmBinData" + $ref: "#/definitions/tapi.eth.EthOnDemandMeasurementJobControlSource" responses: 201: description: "Object created" @@ -8395,25 +9079,22 @@ paths: description: "Object already exists" put: tags: - - "tapi-oam" - description: "creates or updates tapi.oam.PmBinData" + - "tapi-eth" + summary: "creates or updates tapi.eth.EthOnDemandMeasurementJobControlSource" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" + description: "Id of oam-job" required: true type: "string" - in: "body" - name: "tapi.oam.PmBinData.body-param" - description: "tapi.oam.PmBinData to be added or updated" + name: "tapi.eth.EthOnDemandMeasurementJobControlSource.body-param" + description: "tapi.eth.EthOnDemandMeasurementJobControlSource to be added\ + \ or updated" required: false schema: - $ref: "#/definitions/tapi.oam.PmBinData" + $ref: "#/definitions/tapi.eth.EthOnDemandMeasurementJobControlSource" responses: 201: description: "Object created" @@ -8423,17 +9104,13 @@ paths: description: "Object modified" delete: tags: - - "tapi-oam" - description: "removes tapi.oam.PmBinData" + - "tapi-eth" + summary: "removes tapi.eth.EthOnDemandMeasurementJobControlSource" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" + description: "Id of oam-job" required: true type: "string" responses: @@ -8441,50 +9118,43 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-bin-data={local-id}/granularity-period/: + /data/context/oam-context/oam-job={uuid}/eth-on-demand-single-ended-measurement-job/: get: tags: - - "tapi-oam" - description: "returns tapi.common.TimePeriod" + - "tapi-eth" + summary: "returns tapi.eth.EthOnDemandSingleEndedMeasurementJob" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" + description: "Id of oam-job" required: true type: "string" responses: 200: - description: "tapi.common.TimePeriod" + description: "tapi.eth.EthOnDemandSingleEndedMeasurementJob" schema: - $ref: "#/definitions/tapi.common.TimePeriod" + $ref: "#/definitions/tapi.eth.EthOnDemandSingleEndedMeasurementJob" 400: description: "Internal error" post: tags: - - "tapi-oam" - description: "creates tapi.common.TimePeriod" + - "tapi-eth" + summary: "creates tapi.eth.EthOnDemandSingleEndedMeasurementJob" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" + description: "Id of oam-job" required: true type: "string" - in: "body" - name: "tapi.common.TimePeriod.body-param" - description: "tapi.common.TimePeriod to be added to list" + name: "tapi.eth.EthOnDemandSingleEndedMeasurementJob.body-param" + description: "tapi.eth.EthOnDemandSingleEndedMeasurementJob to be added to\ + \ list" required: false schema: - $ref: "#/definitions/tapi.common.TimePeriod" + $ref: "#/definitions/tapi.eth.EthOnDemandSingleEndedMeasurementJob" responses: 201: description: "Object created" @@ -8494,25 +9164,22 @@ paths: description: "Object already exists" put: tags: - - "tapi-oam" - description: "creates or updates tapi.common.TimePeriod" + - "tapi-eth" + summary: "creates or updates tapi.eth.EthOnDemandSingleEndedMeasurementJob" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" + description: "Id of oam-job" required: true type: "string" - in: "body" - name: "tapi.common.TimePeriod.body-param" - description: "tapi.common.TimePeriod to be added or updated" + name: "tapi.eth.EthOnDemandSingleEndedMeasurementJob.body-param" + description: "tapi.eth.EthOnDemandSingleEndedMeasurementJob to be added or\ + \ updated" required: false schema: - $ref: "#/definitions/tapi.common.TimePeriod" + $ref: "#/definitions/tapi.eth.EthOnDemandSingleEndedMeasurementJob" responses: 201: description: "Object created" @@ -8522,17 +9189,13 @@ paths: description: "Object modified" delete: tags: - - "tapi-oam" - description: "removes tapi.common.TimePeriod" + - "tapi-eth" + summary: "removes tapi.eth.EthOnDemandSingleEndedMeasurementJob" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" + description: "Id of oam-job" required: true type: "string" responses: @@ -8540,28 +9203,43 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-bin-data={local-id}/name/: - post: + ? /data/context/oam-context/oam-job={uuid}/eth-on-demand-single-ended-measurement-job/eth-on-demand-measurement-job-control-source/ + : get: tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" + - "tapi-eth" + summary: "returns tapi.eth.EthOnDemandMeasurementJobControlSource" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-job" required: true type: "string" - - name: "local-id" + responses: + 200: + description: "tapi.eth.EthOnDemandMeasurementJobControlSource" + schema: + $ref: "#/definitions/tapi.eth.EthOnDemandMeasurementJobControlSource" + 400: + description: "Internal error" + post: + tags: + - "tapi-eth" + summary: "creates tapi.eth.EthOnDemandMeasurementJobControlSource" + description: "none" + parameters: + - name: "uuid" in: "path" - description: "Id of pm-bin-data" + description: "Id of oam-job" required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.eth.EthOnDemandMeasurementJobControlSource.body-param" + description: "tapi.eth.EthOnDemandMeasurementJobControlSource to be added\ + \ to list" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.eth.EthOnDemandMeasurementJobControlSource" responses: 201: description: "Object created" @@ -8569,60 +9247,84 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/pm-bin-data={local-id}/name={value-name}/: - get: + put: tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" + - "tapi-eth" + summary: "creates or updates tapi.eth.EthOnDemandMeasurementJobControlSource" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of oam-job" required: true type: "string" + - in: "body" + name: "tapi.eth.EthOnDemandMeasurementJobControlSource.body-param" + description: "tapi.eth.EthOnDemandMeasurementJobControlSource to be added\ + \ or updated" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthOnDemandMeasurementJobControlSource" responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" + 201: + description: "Object created" 400: description: "Internal error" - post: + 204: + description: "Object modified" + delete: tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: + - "tapi-eth" + summary: "removes tapi.eth.EthOnDemandMeasurementJobControlSource" + description: "none" + parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-job" required: true type: "string" - - name: "local-id" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-job={uuid}/eth-pro-active-dual-ended-measurement-job/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthProActiveDualEndedMeasurementJob" + description: "none" + parameters: + - name: "uuid" in: "path" - description: "Id of pm-bin-data" + description: "Id of oam-job" required: true type: "string" - - name: "value-name" + responses: + 200: + description: "tapi.eth.EthProActiveDualEndedMeasurementJob" + schema: + $ref: "#/definitions/tapi.eth.EthProActiveDualEndedMeasurementJob" + 400: + description: "Internal error" + post: + tags: + - "tapi-eth" + summary: "creates tapi.eth.EthProActiveDualEndedMeasurementJob" + description: "none" + parameters: + - name: "uuid" in: "path" - description: "Id of name" + description: "Id of oam-job" required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.eth.EthProActiveDualEndedMeasurementJob.body-param" + description: "tapi.eth.EthProActiveDualEndedMeasurementJob to be added to\ + \ list" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.eth.EthProActiveDualEndedMeasurementJob" responses: 201: description: "Object created" @@ -8632,30 +9334,22 @@ paths: description: "Object already exists" put: tags: - - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" + - "tapi-eth" + summary: "creates or updates tapi.eth.EthProActiveDualEndedMeasurementJob" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of oam-job" required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" + name: "tapi.eth.EthProActiveDualEndedMeasurementJob.body-param" + description: "tapi.eth.EthProActiveDualEndedMeasurementJob to be added or\ + \ updated" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.eth.EthProActiveDualEndedMeasurementJob" responses: 201: description: "Object created" @@ -8665,22 +9359,13 @@ paths: description: "Object modified" delete: tags: - - "tapi-oam" - description: "removes tapi.common.NameAndValue" + - "tapi-eth" + summary: "removes tapi.eth.EthProActiveDualEndedMeasurementJob" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of oam-job" required: true type: "string" responses: @@ -8688,74 +9373,43 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data/: - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.oamprofile.PmThresholdData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - in: "body" - name: "tapi.oam.oamprofile.PmThresholdData.body-param" - description: "tapi.oam.oamprofile.PmThresholdData to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.oamprofile.PmThresholdData" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/: + /data/context/oam-context/oam-job={uuid}/eth-pro-active-dual-ended-measurement-job/eth-pro-active-measurement-job-control-sink/: get: tags: - - "tapi-oam" - description: "returns tapi.oam.oamprofile.PmThresholdData" + - "tapi-eth" + summary: "returns tapi.eth.EthProActiveMeasurementJobControlSink" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-job" required: true type: "string" responses: 200: - description: "tapi.oam.oamprofile.PmThresholdData" + description: "tapi.eth.EthProActiveMeasurementJobControlSink" schema: - $ref: "#/definitions/tapi.oam.oamprofile.PmThresholdData" + $ref: "#/definitions/tapi.eth.EthProActiveMeasurementJobControlSink" 400: description: "Internal error" post: tags: - - "tapi-oam" - description: "creates tapi.oam.oamprofile.PmThresholdData" + - "tapi-eth" + summary: "creates tapi.eth.EthProActiveMeasurementJobControlSink" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-job" required: true type: "string" - in: "body" - name: "tapi.oam.oamprofile.PmThresholdData.body-param" - description: "tapi.oam.oamprofile.PmThresholdData to be added to list" + name: "tapi.eth.EthProActiveMeasurementJobControlSink.body-param" + description: "tapi.eth.EthProActiveMeasurementJobControlSink to be added to\ + \ list" required: false schema: - $ref: "#/definitions/tapi.oam.oamprofile.PmThresholdData" + $ref: "#/definitions/tapi.eth.EthProActiveMeasurementJobControlSink" responses: 201: description: "Object created" @@ -8765,25 +9419,22 @@ paths: description: "Object already exists" put: tags: - - "tapi-oam" - description: "creates or updates tapi.oam.oamprofile.PmThresholdData" + - "tapi-eth" + summary: "creates or updates tapi.eth.EthProActiveMeasurementJobControlSink" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-job" required: true type: "string" - in: "body" - name: "tapi.oam.oamprofile.PmThresholdData.body-param" - description: "tapi.oam.oamprofile.PmThresholdData to be added or updated" + name: "tapi.eth.EthProActiveMeasurementJobControlSink.body-param" + description: "tapi.eth.EthProActiveMeasurementJobControlSink to be added or\ + \ updated" required: false schema: - $ref: "#/definitions/tapi.oam.oamprofile.PmThresholdData" + $ref: "#/definitions/tapi.eth.EthProActiveMeasurementJobControlSink" responses: 201: description: "Object created" @@ -8793,17 +9444,13 @@ paths: description: "Object modified" delete: tags: - - "tapi-oam" - description: "removes tapi.oam.oamprofile.PmThresholdData" + - "tapi-eth" + summary: "removes tapi.eth.EthProActiveMeasurementJobControlSink" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-job" required: true type: "string" responses: @@ -8811,50 +9458,43 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/eth-1-dm-threshold-data/: - get: + ? /data/context/oam-context/oam-job={uuid}/eth-pro-active-dual-ended-measurement-job/eth-pro-active-measurement-job-control-source/ + : get: tags: - "tapi-eth" - description: "returns tapi.eth.Eth1DmThresholdData" + summary: "returns tapi.eth.EthProActiveMeasurementJobControlSource" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-job" required: true type: "string" responses: 200: - description: "tapi.eth.Eth1DmThresholdData" + description: "tapi.eth.EthProActiveMeasurementJobControlSource" schema: - $ref: "#/definitions/tapi.eth.Eth1DmThresholdData" + $ref: "#/definitions/tapi.eth.EthProActiveMeasurementJobControlSource" 400: description: "Internal error" post: tags: - "tapi-eth" - description: "creates tapi.eth.Eth1DmThresholdData" + summary: "creates tapi.eth.EthProActiveMeasurementJobControlSource" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-job" required: true type: "string" - in: "body" - name: "tapi.eth.Eth1DmThresholdData.body-param" - description: "tapi.eth.Eth1DmThresholdData to be added to list" + name: "tapi.eth.EthProActiveMeasurementJobControlSource.body-param" + description: "tapi.eth.EthProActiveMeasurementJobControlSource to be added\ + \ to list" required: false schema: - $ref: "#/definitions/tapi.eth.Eth1DmThresholdData" + $ref: "#/definitions/tapi.eth.EthProActiveMeasurementJobControlSource" responses: 201: description: "Object created" @@ -8865,24 +9505,21 @@ paths: put: tags: - "tapi-eth" - description: "creates or updates tapi.eth.Eth1DmThresholdData" + summary: "creates or updates tapi.eth.EthProActiveMeasurementJobControlSource" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-job" required: true type: "string" - in: "body" - name: "tapi.eth.Eth1DmThresholdData.body-param" - description: "tapi.eth.Eth1DmThresholdData to be added or updated" + name: "tapi.eth.EthProActiveMeasurementJobControlSource.body-param" + description: "tapi.eth.EthProActiveMeasurementJobControlSource to be added\ + \ or updated" required: false schema: - $ref: "#/definitions/tapi.eth.Eth1DmThresholdData" + $ref: "#/definitions/tapi.eth.EthProActiveMeasurementJobControlSource" responses: 201: description: "Object created" @@ -8893,16 +9530,12 @@ paths: delete: tags: - "tapi-eth" - description: "removes tapi.eth.Eth1DmThresholdData" + summary: "removes tapi.eth.EthProActiveMeasurementJobControlSource" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-job" required: true type: "string" responses: @@ -8910,50 +9543,43 @@ paths: description: "Internal error" 204: description: "Object deleted" - ? /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/eth-1-dm-threshold-data/near-end-1-dm-clear-threshold/ - : get: + /data/context/oam-context/oam-job={uuid}/eth-pro-active-single-ended-measurement-job/: + get: tags: - "tapi-eth" - description: "returns tapi.eth.StatisticalDmPerformanceParameters" + summary: "returns tapi.eth.EthProActiveSingleEndedMeasurementJob" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-job" required: true type: "string" responses: 200: - description: "tapi.eth.StatisticalDmPerformanceParameters" + description: "tapi.eth.EthProActiveSingleEndedMeasurementJob" schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + $ref: "#/definitions/tapi.eth.EthProActiveSingleEndedMeasurementJob" 400: description: "Internal error" post: tags: - "tapi-eth" - description: "creates tapi.eth.StatisticalDmPerformanceParameters" + summary: "creates tapi.eth.EthProActiveSingleEndedMeasurementJob" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-job" required: true type: "string" - in: "body" - name: "tapi.eth.StatisticalDmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalDmPerformanceParameters to be added to list" + name: "tapi.eth.EthProActiveSingleEndedMeasurementJob.body-param" + description: "tapi.eth.EthProActiveSingleEndedMeasurementJob to be added to\ + \ list" required: false schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + $ref: "#/definitions/tapi.eth.EthProActiveSingleEndedMeasurementJob" responses: 201: description: "Object created" @@ -8964,24 +9590,21 @@ paths: put: tags: - "tapi-eth" - description: "creates or updates tapi.eth.StatisticalDmPerformanceParameters" + summary: "creates or updates tapi.eth.EthProActiveSingleEndedMeasurementJob" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-job" required: true type: "string" - in: "body" - name: "tapi.eth.StatisticalDmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalDmPerformanceParameters to be added or updated" + name: "tapi.eth.EthProActiveSingleEndedMeasurementJob.body-param" + description: "tapi.eth.EthProActiveSingleEndedMeasurementJob to be added or\ + \ updated" required: false schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + $ref: "#/definitions/tapi.eth.EthProActiveSingleEndedMeasurementJob" responses: 201: description: "Object created" @@ -8992,16 +9615,12 @@ paths: delete: tags: - "tapi-eth" - description: "removes tapi.eth.StatisticalDmPerformanceParameters" + summary: "removes tapi.eth.EthProActiveSingleEndedMeasurementJob" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-job" required: true type: "string" responses: @@ -9009,50 +9628,43 @@ paths: description: "Internal error" 204: description: "Object deleted" - ? /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/eth-1-dm-threshold-data/near-end-1-dm-cross-threshold/ + ? /data/context/oam-context/oam-job={uuid}/eth-pro-active-single-ended-measurement-job/eth-pro-active-measurement-job-control-source/ : get: tags: - "tapi-eth" - description: "returns tapi.eth.StatisticalDmPerformanceParameters" + summary: "returns tapi.eth.EthProActiveMeasurementJobControlSource" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-job" required: true type: "string" responses: 200: - description: "tapi.eth.StatisticalDmPerformanceParameters" + description: "tapi.eth.EthProActiveMeasurementJobControlSource" schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + $ref: "#/definitions/tapi.eth.EthProActiveMeasurementJobControlSource" 400: description: "Internal error" post: tags: - "tapi-eth" - description: "creates tapi.eth.StatisticalDmPerformanceParameters" + summary: "creates tapi.eth.EthProActiveMeasurementJobControlSource" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-job" required: true type: "string" - in: "body" - name: "tapi.eth.StatisticalDmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalDmPerformanceParameters to be added to list" + name: "tapi.eth.EthProActiveMeasurementJobControlSource.body-param" + description: "tapi.eth.EthProActiveMeasurementJobControlSource to be added\ + \ to list" required: false schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + $ref: "#/definitions/tapi.eth.EthProActiveMeasurementJobControlSource" responses: 201: description: "Object created" @@ -9063,24 +9675,21 @@ paths: put: tags: - "tapi-eth" - description: "creates or updates tapi.eth.StatisticalDmPerformanceParameters" + summary: "creates or updates tapi.eth.EthProActiveMeasurementJobControlSource" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-job" required: true type: "string" - in: "body" - name: "tapi.eth.StatisticalDmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalDmPerformanceParameters to be added or updated" + name: "tapi.eth.EthProActiveMeasurementJobControlSource.body-param" + description: "tapi.eth.EthProActiveMeasurementJobControlSource to be added\ + \ or updated" required: false schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + $ref: "#/definitions/tapi.eth.EthProActiveMeasurementJobControlSource" responses: 201: description: "Object created" @@ -9091,16 +9700,12 @@ paths: delete: tags: - "tapi-eth" - description: "removes tapi.eth.StatisticalDmPerformanceParameters" + summary: "removes tapi.eth.EthProActiveMeasurementJobControlSource" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-job" required: true type: "string" responses: @@ -9108,50 +9713,42 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/eth-1-lm-threshold-data/: + /data/context/oam-context/oam-job={uuid}/eth-test-job/: get: tags: - "tapi-eth" - description: "returns tapi.eth.Eth1LmThresholdData" + summary: "returns tapi.eth.EthTestJob" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-job" required: true type: "string" responses: 200: - description: "tapi.eth.Eth1LmThresholdData" + description: "tapi.eth.EthTestJob" schema: - $ref: "#/definitions/tapi.eth.Eth1LmThresholdData" + $ref: "#/definitions/tapi.eth.EthTestJob" 400: description: "Internal error" post: tags: - "tapi-eth" - description: "creates tapi.eth.Eth1LmThresholdData" + summary: "creates tapi.eth.EthTestJob" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-job" required: true type: "string" - in: "body" - name: "tapi.eth.Eth1LmThresholdData.body-param" - description: "tapi.eth.Eth1LmThresholdData to be added to list" + name: "tapi.eth.EthTestJob.body-param" + description: "tapi.eth.EthTestJob to be added to list" required: false schema: - $ref: "#/definitions/tapi.eth.Eth1LmThresholdData" + $ref: "#/definitions/tapi.eth.EthTestJob" responses: 201: description: "Object created" @@ -9162,24 +9759,20 @@ paths: put: tags: - "tapi-eth" - description: "creates or updates tapi.eth.Eth1LmThresholdData" + summary: "creates or updates tapi.eth.EthTestJob" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-job" required: true type: "string" - in: "body" - name: "tapi.eth.Eth1LmThresholdData.body-param" - description: "tapi.eth.Eth1LmThresholdData to be added or updated" + name: "tapi.eth.EthTestJob.body-param" + description: "tapi.eth.EthTestJob to be added or updated" required: false schema: - $ref: "#/definitions/tapi.eth.Eth1LmThresholdData" + $ref: "#/definitions/tapi.eth.EthTestJob" responses: 201: description: "Object created" @@ -9190,16 +9783,12 @@ paths: delete: tags: - "tapi-eth" - description: "removes tapi.eth.Eth1LmThresholdData" + summary: "removes tapi.eth.EthTestJob" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-job" required: true type: "string" responses: @@ -9207,50 +9796,42 @@ paths: description: "Internal error" 204: description: "Object deleted" - ? /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/eth-1-lm-threshold-data/near-end-1-lm-clear-threshold/ - : get: + /data/context/oam-context/oam-job={uuid}/eth-test-job/eth-oam-test-loopback-common-pac/: + get: tags: - "tapi-eth" - description: "returns tapi.eth.StatisticalLmPerformanceParameters" + summary: "returns tapi.eth.EthOamTestLoopbackCommonPac" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-job" required: true type: "string" responses: 200: - description: "tapi.eth.StatisticalLmPerformanceParameters" + description: "tapi.eth.EthOamTestLoopbackCommonPac" schema: - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" + $ref: "#/definitions/tapi.eth.EthOamTestLoopbackCommonPac" 400: description: "Internal error" post: tags: - "tapi-eth" - description: "creates tapi.eth.StatisticalLmPerformanceParameters" + summary: "creates tapi.eth.EthOamTestLoopbackCommonPac" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-job" required: true type: "string" - in: "body" - name: "tapi.eth.StatisticalLmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalLmPerformanceParameters to be added to list" + name: "tapi.eth.EthOamTestLoopbackCommonPac.body-param" + description: "tapi.eth.EthOamTestLoopbackCommonPac to be added to list" required: false schema: - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" + $ref: "#/definitions/tapi.eth.EthOamTestLoopbackCommonPac" responses: 201: description: "Object created" @@ -9261,24 +9842,20 @@ paths: put: tags: - "tapi-eth" - description: "creates or updates tapi.eth.StatisticalLmPerformanceParameters" + summary: "creates or updates tapi.eth.EthOamTestLoopbackCommonPac" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-job" required: true type: "string" - in: "body" - name: "tapi.eth.StatisticalLmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalLmPerformanceParameters to be added or updated" + name: "tapi.eth.EthOamTestLoopbackCommonPac.body-param" + description: "tapi.eth.EthOamTestLoopbackCommonPac to be added or updated" required: false schema: - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" + $ref: "#/definitions/tapi.eth.EthOamTestLoopbackCommonPac" responses: 201: description: "Object created" @@ -9289,16 +9866,12 @@ paths: delete: tags: - "tapi-eth" - description: "removes tapi.eth.StatisticalLmPerformanceParameters" + summary: "removes tapi.eth.EthOamTestLoopbackCommonPac" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-job" required: true type: "string" responses: @@ -9306,50 +9879,42 @@ paths: description: "Internal error" 204: description: "Object deleted" - ? /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/eth-1-lm-threshold-data/near-end-1-lm-cross-threshold/ - : get: + /data/context/oam-context/oam-job={uuid}/eth-test-job/eth-test-job-sink-point/: + get: tags: - "tapi-eth" - description: "returns tapi.eth.StatisticalLmPerformanceParameters" + summary: "returns tapi.eth.EthTestJobSinkPoint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-job" required: true type: "string" responses: 200: - description: "tapi.eth.StatisticalLmPerformanceParameters" + description: "tapi.eth.EthTestJobSinkPoint" schema: - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" + $ref: "#/definitions/tapi.eth.EthTestJobSinkPoint" 400: description: "Internal error" post: tags: - "tapi-eth" - description: "creates tapi.eth.StatisticalLmPerformanceParameters" + summary: "creates tapi.eth.EthTestJobSinkPoint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-job" required: true type: "string" - in: "body" - name: "tapi.eth.StatisticalLmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalLmPerformanceParameters to be added to list" + name: "tapi.eth.EthTestJobSinkPoint.body-param" + description: "tapi.eth.EthTestJobSinkPoint to be added to list" required: false schema: - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" + $ref: "#/definitions/tapi.eth.EthTestJobSinkPoint" responses: 201: description: "Object created" @@ -9360,24 +9925,20 @@ paths: put: tags: - "tapi-eth" - description: "creates or updates tapi.eth.StatisticalLmPerformanceParameters" + summary: "creates or updates tapi.eth.EthTestJobSinkPoint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-job" required: true type: "string" - in: "body" - name: "tapi.eth.StatisticalLmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalLmPerformanceParameters to be added or updated" + name: "tapi.eth.EthTestJobSinkPoint.body-param" + description: "tapi.eth.EthTestJobSinkPoint to be added or updated" required: false schema: - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" + $ref: "#/definitions/tapi.eth.EthTestJobSinkPoint" responses: 201: description: "Object created" @@ -9388,16 +9949,12 @@ paths: delete: tags: - "tapi-eth" - description: "removes tapi.eth.StatisticalLmPerformanceParameters" + summary: "removes tapi.eth.EthTestJobSinkPoint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-job" required: true type: "string" responses: @@ -9405,78 +9962,83 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/eth-dm-threshold-data/: - get: + /data/context/oam-context/oam-job={uuid}/name/: + post: tags: - - "tapi-eth" - description: "returns tapi.eth.EthDmThresholdData" + - "tapi-oam" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-job" required: true type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" responses: - 200: - description: "tapi.eth.EthDmThresholdData" - schema: - $ref: "#/definitions/tapi.eth.EthDmThresholdData" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + /data/context/oam-context/oam-job={uuid}/name={value-name}/: + get: tags: - - "tapi-eth" - description: "creates tapi.eth.EthDmThresholdData" + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-job" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of pm-threshold-data" + description: "Id of name" required: true type: "string" - - in: "body" - name: "tapi.eth.EthDmThresholdData.body-param" - description: "tapi.eth.EthDmThresholdData to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthDmThresholdData" responses: - 201: - description: "Object created" + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - - "tapi-eth" - description: "creates or updates tapi.eth.EthDmThresholdData" + - "tapi-oam" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-job" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of pm-threshold-data" + description: "Id of name" required: true type: "string" - in: "body" - name: "tapi.eth.EthDmThresholdData.body-param" - description: "tapi.eth.EthDmThresholdData to be added or updated" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.eth.EthDmThresholdData" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -9486,17 +10048,20 @@ paths: description: "Object modified" delete: tags: - - "tapi-eth" - description: "removes tapi.eth.EthDmThresholdData" + - "tapi-oam" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-job" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of pm-threshold-data" + description: "Id of name" required: true type: "string" responses: @@ -9504,50 +10069,42 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/eth-dm-threshold-data/bi-dir-dm-clear-threshold/: + /data/context/oam-context/oam-job={uuid}/oam-profile/: get: tags: - - "tapi-eth" - description: "returns tapi.eth.StatisticalDmPerformanceParameters" + - "tapi-oam" + summary: "returns tapi.oam.OamProfileRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-job" required: true type: "string" responses: 200: - description: "tapi.eth.StatisticalDmPerformanceParameters" + description: "tapi.oam.OamProfileRef" schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + $ref: "#/definitions/tapi.oam.OamProfileRef" 400: description: "Internal error" post: tags: - - "tapi-eth" - description: "creates tapi.eth.StatisticalDmPerformanceParameters" + - "tapi-oam" + summary: "creates tapi.oam.OamProfileRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-job" required: true type: "string" - in: "body" - name: "tapi.eth.StatisticalDmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalDmPerformanceParameters to be added to list" + name: "tapi.oam.OamProfileRef.body-param" + description: "tapi.oam.OamProfileRef to be added to list" required: false schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + $ref: "#/definitions/tapi.oam.OamProfileRef" responses: 201: description: "Object created" @@ -9557,25 +10114,21 @@ paths: description: "Object already exists" put: tags: - - "tapi-eth" - description: "creates or updates tapi.eth.StatisticalDmPerformanceParameters" + - "tapi-oam" + summary: "creates or updates tapi.oam.OamProfileRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-job" required: true type: "string" - in: "body" - name: "tapi.eth.StatisticalDmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalDmPerformanceParameters to be added or updated" + name: "tapi.oam.OamProfileRef.body-param" + description: "tapi.oam.OamProfileRef to be added or updated" required: false schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + $ref: "#/definitions/tapi.oam.OamProfileRef" responses: 201: description: "Object created" @@ -9585,17 +10138,13 @@ paths: description: "Object modified" delete: tags: - - "tapi-eth" - description: "removes tapi.eth.StatisticalDmPerformanceParameters" + - "tapi-oam" + summary: "removes tapi.oam.OamProfileRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-job" required: true type: "string" responses: @@ -9603,78 +10152,87 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/eth-dm-threshold-data/bi-dir-dm-cross-threshold/: - get: + /data/context/oam-context/oam-job={uuid}/oam-service-point/: + post: tags: - - "tapi-eth" - description: "returns tapi.eth.StatisticalDmPerformanceParameters" + - "tapi-oam" + summary: "creates tapi.oam.OamServicePointRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-job" required: true type: "string" + - in: "body" + name: "tapi.oam.OamServicePointRef.body-param" + description: "tapi.oam.OamServicePointRef to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamServicePointRef" responses: - 200: - description: "tapi.eth.StatisticalDmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + /data/context/oam-context/oam-job={uuid}/oam-service-point={oam-service-uuid},{oam-service-point-local-id}/: + get: tags: - - "tapi-eth" - description: "creates tapi.eth.StatisticalDmPerformanceParameters" + - "tapi-oam" + summary: "returns tapi.oam.OamServicePointRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-job" required: true type: "string" - - name: "local-id" + - name: "oam-service-uuid" in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-service-point" + required: true + type: "string" + - name: "oam-service-point-local-id" + in: "path" + description: "Id of oam-service-point" required: true type: "string" - - in: "body" - name: "tapi.eth.StatisticalDmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalDmPerformanceParameters to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" responses: - 201: - description: "Object created" + 200: + description: "tapi.oam.OamServicePointRef" + schema: + $ref: "#/definitions/tapi.oam.OamServicePointRef" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - - "tapi-eth" - description: "creates or updates tapi.eth.StatisticalDmPerformanceParameters" + - "tapi-oam" + summary: "creates or updates tapi.oam.OamServicePointRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-job" required: true type: "string" - - name: "local-id" + - name: "oam-service-uuid" in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-service-point" + required: true + type: "string" + - name: "oam-service-point-local-id" + in: "path" + description: "Id of oam-service-point" required: true type: "string" - in: "body" - name: "tapi.eth.StatisticalDmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalDmPerformanceParameters to be added or updated" + name: "tapi.oam.OamServicePointRef.body-param" + description: "tapi.oam.OamServicePointRef to be added or updated" required: false schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + $ref: "#/definitions/tapi.oam.OamServicePointRef" responses: 201: description: "Object created" @@ -9684,17 +10242,23 @@ paths: description: "Object modified" delete: tags: - - "tapi-eth" - description: "removes tapi.eth.StatisticalDmPerformanceParameters" + - "tapi-oam" + summary: "removes tapi.oam.OamServicePointRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-job" required: true type: "string" - - name: "local-id" + - name: "oam-service-uuid" in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-service-point" + required: true + type: "string" + - name: "oam-service-point-local-id" + in: "path" + description: "Id of oam-service-point" required: true type: "string" responses: @@ -9702,50 +10266,42 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/eth-dm-threshold-data/far-end-dm-clear-threshold/: + /data/context/oam-context/oam-job={uuid}/schedule/: get: tags: - - "tapi-eth" - description: "returns tapi.eth.StatisticalDmPerformanceParameters" + - "tapi-oam" + summary: "returns tapi.common.TimeRange" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-job" required: true type: "string" responses: 200: - description: "tapi.eth.StatisticalDmPerformanceParameters" + description: "tapi.common.TimeRange" schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + $ref: "#/definitions/tapi.common.TimeRange" 400: description: "Internal error" post: tags: - - "tapi-eth" - description: "creates tapi.eth.StatisticalDmPerformanceParameters" + - "tapi-oam" + summary: "creates tapi.common.TimeRange" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-job" required: true type: "string" - in: "body" - name: "tapi.eth.StatisticalDmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalDmPerformanceParameters to be added to list" + name: "tapi.common.TimeRange.body-param" + description: "tapi.common.TimeRange to be added to list" required: false schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + $ref: "#/definitions/tapi.common.TimeRange" responses: 201: description: "Object created" @@ -9755,25 +10311,21 @@ paths: description: "Object already exists" put: tags: - - "tapi-eth" - description: "creates or updates tapi.eth.StatisticalDmPerformanceParameters" + - "tapi-oam" + summary: "creates or updates tapi.common.TimeRange" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-job" required: true type: "string" - in: "body" - name: "tapi.eth.StatisticalDmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalDmPerformanceParameters to be added or updated" + name: "tapi.common.TimeRange.body-param" + description: "tapi.common.TimeRange to be added or updated" required: false schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + $ref: "#/definitions/tapi.common.TimeRange" responses: 201: description: "Object created" @@ -9783,17 +10335,13 @@ paths: description: "Object modified" delete: tags: - - "tapi-eth" - description: "removes tapi.eth.StatisticalDmPerformanceParameters" + - "tapi-oam" + summary: "removes tapi.common.TimeRange" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-job" required: true type: "string" responses: @@ -9801,50 +10349,105 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/eth-dm-threshold-data/far-end-dm-cross-threshold/: + /data/context/oam-context/oam-profile/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.OamProfile" + description: "none" + parameters: + - in: "body" + name: "tapi.oam.OamProfile.body-param" + description: "tapi.oam.OamProfile to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamProfile" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-profile={uuid}/: get: tags: - - "tapi-eth" - description: "returns tapi.eth.StatisticalDmPerformanceParameters" + - "tapi-oam" + summary: "returns tapi.oam.OamProfile" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-profile" required: true type: "string" - - name: "local-id" + responses: + 200: + description: "tapi.oam.OamProfile" + schema: + $ref: "#/definitions/tapi.oam.OamProfile" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.OamProfile" + description: "none" + parameters: + - name: "uuid" in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-profile" required: true type: "string" + - in: "body" + name: "tapi.oam.OamProfile.body-param" + description: "tapi.oam.OamProfile to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamProfile" responses: - 200: - description: "tapi.eth.StatisticalDmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + 201: + description: "Object created" 400: description: "Internal error" - post: + 204: + description: "Object modified" + delete: tags: - - "tapi-eth" - description: "creates tapi.eth.StatisticalDmPerformanceParameters" + - "tapi-oam" + summary: "removes tapi.oam.OamProfile" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-profile" required: true type: "string" - - name: "local-id" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-profile={uuid}/name/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-profile" required: true type: "string" - in: "body" - name: "tapi.eth.StatisticalDmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalDmPerformanceParameters to be added to list" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -9852,27 +10455,56 @@ paths: description: "Internal error" 409: description: "Object already exists" + /data/context/oam-context/oam-profile={uuid}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" put: tags: - - "tapi-eth" - description: "creates or updates tapi.eth.StatisticalDmPerformanceParameters" + - "tapi-oam" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of oam-profile" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of pm-threshold-data" + description: "Id of name" required: true type: "string" - in: "body" - name: "tapi.eth.StatisticalDmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalDmPerformanceParameters to be added or updated" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -9882,17 +10514,20 @@ paths: description: "Object modified" delete: tags: - - "tapi-eth" - description: "removes tapi.eth.StatisticalDmPerformanceParameters" + - "tapi-oam" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of oam-profile" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of pm-threshold-data" + description: "Id of name" required: true type: "string" responses: @@ -9900,33 +10535,37 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/eth-dm-threshold-data/near-end-dm-clear-threshold/: - get: + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data/: + post: tags: - - "tapi-eth" - description: "returns tapi.eth.StatisticalDmPerformanceParameters" + - "tapi-oam" + summary: "creates tapi.oam.PmThresholdData" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-profile" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" + - in: "body" + name: "tapi.oam.PmThresholdData.body-param" + description: "tapi.oam.PmThresholdData to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.PmThresholdData" responses: - 200: - description: "tapi.eth.StatisticalDmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/: + get: tags: - - "tapi-eth" - description: "creates tapi.eth.StatisticalDmPerformanceParameters" + - "tapi-oam" + summary: "returns tapi.oam.PmThresholdData" + description: "none" parameters: - name: "uuid" in: "path" @@ -9938,23 +10577,18 @@ paths: description: "Id of pm-threshold-data" required: true type: "string" - - in: "body" - name: "tapi.eth.StatisticalDmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalDmPerformanceParameters to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" responses: - 201: - description: "Object created" + 200: + description: "tapi.oam.PmThresholdData" + schema: + $ref: "#/definitions/tapi.oam.PmThresholdData" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - - "tapi-eth" - description: "creates or updates tapi.eth.StatisticalDmPerformanceParameters" + - "tapi-oam" + summary: "creates or updates tapi.oam.PmThresholdData" + description: "none" parameters: - name: "uuid" in: "path" @@ -9967,11 +10601,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.eth.StatisticalDmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalDmPerformanceParameters to be added or updated" + name: "tapi.oam.PmThresholdData.body-param" + description: "tapi.oam.PmThresholdData to be added or updated" required: false schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + $ref: "#/definitions/tapi.oam.PmThresholdData" responses: 201: description: "Object created" @@ -9981,8 +10615,9 @@ paths: description: "Object modified" delete: tags: - - "tapi-eth" - description: "removes tapi.eth.StatisticalDmPerformanceParameters" + - "tapi-oam" + summary: "removes tapi.oam.PmThresholdData" + description: "none" parameters: - name: "uuid" in: "path" @@ -9999,11 +10634,12 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/eth-dm-threshold-data/near-end-dm-cross-threshold/: + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/granularity-period/: get: tags: - - "tapi-eth" - description: "returns tapi.eth.StatisticalDmPerformanceParameters" + - "tapi-oam" + summary: "returns tapi.common.TimePeriod" + description: "none" parameters: - name: "uuid" in: "path" @@ -10017,15 +10653,16 @@ paths: type: "string" responses: 200: - description: "tapi.eth.StatisticalDmPerformanceParameters" + description: "tapi.common.TimePeriod" schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + $ref: "#/definitions/tapi.common.TimePeriod" 400: description: "Internal error" post: tags: - - "tapi-eth" - description: "creates tapi.eth.StatisticalDmPerformanceParameters" + - "tapi-oam" + summary: "creates tapi.common.TimePeriod" + description: "none" parameters: - name: "uuid" in: "path" @@ -10038,11 +10675,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.eth.StatisticalDmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalDmPerformanceParameters to be added to list" + name: "tapi.common.TimePeriod.body-param" + description: "tapi.common.TimePeriod to be added to list" required: false schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + $ref: "#/definitions/tapi.common.TimePeriod" responses: 201: description: "Object created" @@ -10052,8 +10689,9 @@ paths: description: "Object already exists" put: tags: - - "tapi-eth" - description: "creates or updates tapi.eth.StatisticalDmPerformanceParameters" + - "tapi-oam" + summary: "creates or updates tapi.common.TimePeriod" + description: "none" parameters: - name: "uuid" in: "path" @@ -10066,11 +10704,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.eth.StatisticalDmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalDmPerformanceParameters to be added or updated" + name: "tapi.common.TimePeriod.body-param" + description: "tapi.common.TimePeriod to be added or updated" required: false schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + $ref: "#/definitions/tapi.common.TimePeriod" responses: 201: description: "Object created" @@ -10080,8 +10718,9 @@ paths: description: "Object modified" delete: tags: - - "tapi-eth" - description: "removes tapi.eth.StatisticalDmPerformanceParameters" + - "tapi-oam" + summary: "removes tapi.common.TimePeriod" + description: "none" parameters: - name: "uuid" in: "path" @@ -10098,11 +10737,14 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/eth-lm-threshold-data/: - get: + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/name/: + post: tags: - - "tapi-eth" - description: "returns tapi.eth.EthLmThresholdData" + - "tapi-oam" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -10114,17 +10756,27 @@ paths: description: "Id of pm-threshold-data" required: true type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" responses: - 200: - description: "tapi.eth.EthLmThresholdData" - schema: - $ref: "#/definitions/tapi.eth.EthLmThresholdData" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/name={value-name}/: + get: tags: - - "tapi-eth" - description: "creates tapi.eth.EthLmThresholdData" + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -10136,23 +10788,25 @@ paths: description: "Id of pm-threshold-data" required: true type: "string" - - in: "body" - name: "tapi.eth.EthLmThresholdData.body-param" - description: "tapi.eth.EthLmThresholdData to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthLmThresholdData" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" responses: - 201: - description: "Object created" + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - - "tapi-eth" - description: "creates or updates tapi.eth.EthLmThresholdData" + - "tapi-oam" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -10164,12 +10818,17 @@ paths: description: "Id of pm-threshold-data" required: true type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" - in: "body" - name: "tapi.eth.EthLmThresholdData.body-param" - description: "tapi.eth.EthLmThresholdData to be added or updated" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.eth.EthLmThresholdData" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -10179,8 +10838,11 @@ paths: description: "Object modified" delete: tags: - - "tapi-eth" - description: "removes tapi.eth.EthLmThresholdData" + - "tapi-oam" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -10192,16 +10854,22 @@ paths: description: "Id of pm-threshold-data" required: true type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/eth-lm-threshold-data/far-end-lm-clear-threshold/: - get: + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/threshold-parameter/: + post: tags: - - "tapi-eth" - description: "returns tapi.eth.StatisticalLmPerformanceParameters" + - "tapi-oam" + summary: "creates tapi.oam.ThresholdParameter" + description: "none" parameters: - name: "uuid" in: "path" @@ -10213,17 +10881,25 @@ paths: description: "Id of pm-threshold-data" required: true type: "string" + - in: "body" + name: "tapi.oam.ThresholdParameter.body-param" + description: "tapi.oam.ThresholdParameter to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.ThresholdParameter" responses: - 200: - description: "tapi.eth.StatisticalLmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + ? /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/threshold-parameter={pm-parameter-name},{threshold-location}/ + : get: tags: - - "tapi-eth" - description: "creates tapi.eth.StatisticalLmPerformanceParameters" + - "tapi-oam" + summary: "returns tapi.oam.ThresholdParameter" + description: "none" parameters: - name: "uuid" in: "path" @@ -10235,23 +10911,28 @@ paths: description: "Id of pm-threshold-data" required: true type: "string" - - in: "body" - name: "tapi.eth.StatisticalLmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalLmPerformanceParameters to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" responses: - 201: - description: "Object created" + 200: + description: "tapi.oam.ThresholdParameter" + schema: + $ref: "#/definitions/tapi.oam.ThresholdParameter" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - - "tapi-eth" - description: "creates or updates tapi.eth.StatisticalLmPerformanceParameters" + - "tapi-oam" + summary: "creates or updates tapi.oam.ThresholdParameter" + description: "none" parameters: - name: "uuid" in: "path" @@ -10263,12 +10944,22 @@ paths: description: "Id of pm-threshold-data" required: true type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" - in: "body" - name: "tapi.eth.StatisticalLmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalLmPerformanceParameters to be added or updated" + name: "tapi.oam.ThresholdParameter.body-param" + description: "tapi.oam.ThresholdParameter to be added or updated" required: false schema: - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" + $ref: "#/definitions/tapi.oam.ThresholdParameter" responses: 201: description: "Object created" @@ -10278,8 +10969,9 @@ paths: description: "Object modified" delete: tags: - - "tapi-eth" - description: "removes tapi.eth.StatisticalLmPerformanceParameters" + - "tapi-oam" + summary: "removes tapi.oam.ThresholdParameter" + description: "none" parameters: - name: "uuid" in: "path" @@ -10291,16 +10983,27 @@ paths: description: "Id of pm-threshold-data" required: true type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/eth-lm-threshold-data/far-end-lm-cross-threshold/: - get: + ? /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/threshold-parameter={pm-parameter-name},{threshold-location}/pm-parameter-above-thrs/ + : get: tags: - - "tapi-eth" - description: "returns tapi.eth.StatisticalLmPerformanceParameters" + - "tapi-oam" + summary: "returns tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -10312,17 +11015,28 @@ paths: description: "Id of pm-threshold-data" required: true type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" responses: 200: - description: "tapi.eth.StatisticalLmPerformanceParameters" + description: "tapi.oam.PmParameterValue" schema: - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" + $ref: "#/definitions/tapi.oam.PmParameterValue" 400: description: "Internal error" post: tags: - - "tapi-eth" - description: "creates tapi.eth.StatisticalLmPerformanceParameters" + - "tapi-oam" + summary: "creates tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -10334,12 +11048,22 @@ paths: description: "Id of pm-threshold-data" required: true type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" - in: "body" - name: "tapi.eth.StatisticalLmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalLmPerformanceParameters to be added to list" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" + $ref: "#/definitions/tapi.oam.PmParameterValue" responses: 201: description: "Object created" @@ -10349,8 +11073,9 @@ paths: description: "Object already exists" put: tags: - - "tapi-eth" - description: "creates or updates tapi.eth.StatisticalLmPerformanceParameters" + - "tapi-oam" + summary: "creates or updates tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -10362,12 +11087,22 @@ paths: description: "Id of pm-threshold-data" required: true type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" - in: "body" - name: "tapi.eth.StatisticalLmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalLmPerformanceParameters to be added or updated" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" + $ref: "#/definitions/tapi.oam.PmParameterValue" responses: 201: description: "Object created" @@ -10377,8 +11112,9 @@ paths: description: "Object modified" delete: tags: - - "tapi-eth" - description: "removes tapi.eth.StatisticalLmPerformanceParameters" + - "tapi-oam" + summary: "removes tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -10390,16 +11126,27 @@ paths: description: "Id of pm-threshold-data" required: true type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/eth-lm-threshold-data/near-end-lm-clear-threshold/: - get: + ? /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/threshold-parameter={pm-parameter-name},{threshold-location}/pm-parameter-below-thrs/ + : get: tags: - - "tapi-eth" - description: "returns tapi.eth.StatisticalLmPerformanceParameters" + - "tapi-oam" + summary: "returns tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -10411,17 +11158,28 @@ paths: description: "Id of pm-threshold-data" required: true type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" responses: 200: - description: "tapi.eth.StatisticalLmPerformanceParameters" + description: "tapi.oam.PmParameterValue" schema: - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" + $ref: "#/definitions/tapi.oam.PmParameterValue" 400: description: "Internal error" post: tags: - - "tapi-eth" - description: "creates tapi.eth.StatisticalLmPerformanceParameters" + - "tapi-oam" + summary: "creates tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -10433,12 +11191,22 @@ paths: description: "Id of pm-threshold-data" required: true type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" - in: "body" - name: "tapi.eth.StatisticalLmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalLmPerformanceParameters to be added to list" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" + $ref: "#/definitions/tapi.oam.PmParameterValue" responses: 201: description: "Object created" @@ -10448,8 +11216,9 @@ paths: description: "Object already exists" put: tags: - - "tapi-eth" - description: "creates or updates tapi.eth.StatisticalLmPerformanceParameters" + - "tapi-oam" + summary: "creates or updates tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -10461,12 +11230,22 @@ paths: description: "Id of pm-threshold-data" required: true type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" - in: "body" - name: "tapi.eth.StatisticalLmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalLmPerformanceParameters to be added or updated" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" + $ref: "#/definitions/tapi.oam.PmParameterValue" responses: 201: description: "Object created" @@ -10476,8 +11255,9 @@ paths: description: "Object modified" delete: tags: - - "tapi-eth" - description: "removes tapi.eth.StatisticalLmPerformanceParameters" + - "tapi-oam" + summary: "removes tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -10489,16 +11269,27 @@ paths: description: "Id of pm-threshold-data" required: true type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/eth-lm-threshold-data/near-end-lm-cross-threshold/: - get: + ? /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/threshold-parameter={pm-parameter-name},{threshold-location}/pm-parameter-clear-thrs/ + : get: tags: - - "tapi-eth" - description: "returns tapi.eth.StatisticalLmPerformanceParameters" + - "tapi-oam" + summary: "returns tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -10510,17 +11301,28 @@ paths: description: "Id of pm-threshold-data" required: true type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" responses: 200: - description: "tapi.eth.StatisticalLmPerformanceParameters" + description: "tapi.oam.PmParameterValue" schema: - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" + $ref: "#/definitions/tapi.oam.PmParameterValue" 400: description: "Internal error" post: tags: - - "tapi-eth" - description: "creates tapi.eth.StatisticalLmPerformanceParameters" + - "tapi-oam" + summary: "creates tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -10532,12 +11334,22 @@ paths: description: "Id of pm-threshold-data" required: true type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" - in: "body" - name: "tapi.eth.StatisticalLmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalLmPerformanceParameters to be added to list" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" + $ref: "#/definitions/tapi.oam.PmParameterValue" responses: 201: description: "Object created" @@ -10547,8 +11359,9 @@ paths: description: "Object already exists" put: tags: - - "tapi-eth" - description: "creates or updates tapi.eth.StatisticalLmPerformanceParameters" + - "tapi-oam" + summary: "creates or updates tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -10560,12 +11373,22 @@ paths: description: "Id of pm-threshold-data" required: true type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" - in: "body" - name: "tapi.eth.StatisticalLmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalLmPerformanceParameters to be added or updated" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" + $ref: "#/definitions/tapi.oam.PmParameterValue" responses: 201: description: "Object created" @@ -10575,8 +11398,9 @@ paths: description: "Object modified" delete: tags: - - "tapi-eth" - description: "removes tapi.eth.StatisticalLmPerformanceParameters" + - "tapi-oam" + summary: "removes tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -10588,55 +11412,34 @@ paths: description: "Id of pm-threshold-data" required: true type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/granularity-period/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.TimePeriod" - parameters: - - name: "uuid" + - name: "pm-parameter-name" in: "path" - description: "Id of oam-profile" + description: "Id of threshold-parameter" required: true type: "string" - - name: "local-id" + - name: "threshold-location" in: "path" - description: "Id of pm-threshold-data" + description: "Id of threshold-parameter" required: true type: "string" responses: - 200: - description: "tapi.common.TimePeriod" - schema: - $ref: "#/definitions/tapi.common.TimePeriod" 400: description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-service/: post: tags: - "tapi-oam" - description: "creates tapi.common.TimePeriod" + summary: "creates tapi.oam.oamcontext.OamService" + description: "none" parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - in: "body" - name: "tapi.common.TimePeriod.body-param" - description: "tapi.common.TimePeriod to be added to list" + name: "tapi.oam.oamcontext.OamService.body-param" + description: "tapi.oam.oamcontext.OamService to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.TimePeriod" + $ref: "#/definitions/tapi.oam.oamcontext.OamService" responses: 201: description: "Object created" @@ -10644,27 +11447,42 @@ paths: description: "Internal error" 409: description: "Object already exists" - put: + /data/context/oam-context/oam-service={uuid}/: + get: tags: - "tapi-oam" - description: "creates or updates tapi.common.TimePeriod" + summary: "returns tapi.oam.oamcontext.OamService" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-service" required: true type: "string" - - name: "local-id" + responses: + 200: + description: "tapi.oam.oamcontext.OamService" + schema: + $ref: "#/definitions/tapi.oam.oamcontext.OamService" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.oamcontext.OamService" + description: "none" + parameters: + - name: "uuid" in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-service" required: true type: "string" - in: "body" - name: "tapi.common.TimePeriod.body-param" - description: "tapi.common.TimePeriod to be added or updated" + name: "tapi.oam.oamcontext.OamService.body-param" + description: "tapi.oam.oamcontext.OamService to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.TimePeriod" + $ref: "#/definitions/tapi.oam.oamcontext.OamService" responses: 201: description: "Object created" @@ -10675,16 +11493,12 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.common.TimePeriod" + summary: "removes tapi.oam.oamcontext.OamService" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-service" required: true type: "string" responses: @@ -10692,89 +11506,42 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/name/: - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/name={value-name}/: + /data/context/oam-context/oam-service={uuid}/eth-oam-service/: get: tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" + - "tapi-eth" + summary: "returns tapi.eth.EthOamService" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of oam-service" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.eth.EthOamService" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.eth.EthOamService" 400: description: "Internal error" post: tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" + - "tapi-eth" + summary: "creates tapi.eth.EthOamService" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of oam-service" required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.eth.EthOamService.body-param" + description: "tapi.eth.EthOamService to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.eth.EthOamService" responses: 201: description: "Object created" @@ -10784,30 +11551,21 @@ paths: description: "Object already exists" put: tags: - - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" + - "tapi-eth" + summary: "creates or updates tapi.eth.EthOamService" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of oam-service" required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" + name: "tapi.eth.EthOamService.body-param" + description: "tapi.eth.EthOamService to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.eth.EthOamService" responses: 201: description: "Object created" @@ -10817,22 +11575,13 @@ paths: description: "Object modified" delete: tags: - - "tapi-oam" - description: "removes tapi.common.NameAndValue" + - "tapi-eth" + summary: "removes tapi.eth.EthOamService" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of oam-service" required: true type: "string" responses: @@ -10840,30 +11589,12 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-service/: - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamService" - parameters: - - in: "body" - name: "tapi.oam.OamService.body-param" - description: "tapi.oam.OamService to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-service={uuid}/: + /data/context/oam-context/oam-service={uuid}/eth-oam-service/eth-cfm-maintenance-association/: get: tags: - - "tapi-oam" - description: "returns tapi.oam.OamService" + - "tapi-eth" + summary: "returns tapi.eth.EthCfmMaintenanceAssociation" + description: "none" parameters: - name: "uuid" in: "path" @@ -10872,15 +11603,16 @@ paths: type: "string" responses: 200: - description: "tapi.oam.OamService" + description: "tapi.eth.EthCfmMaintenanceAssociation" schema: - $ref: "#/definitions/tapi.oam.OamService" + $ref: "#/definitions/tapi.eth.EthCfmMaintenanceAssociation" 400: description: "Internal error" post: tags: - - "tapi-oam" - description: "creates tapi.oam.OamService" + - "tapi-eth" + summary: "creates tapi.eth.EthCfmMaintenanceAssociation" + description: "none" parameters: - name: "uuid" in: "path" @@ -10888,11 +11620,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.oam.OamService.body-param" - description: "tapi.oam.OamService to be added to list" + name: "tapi.eth.EthCfmMaintenanceAssociation.body-param" + description: "tapi.eth.EthCfmMaintenanceAssociation to be added to list" required: false schema: - $ref: "#/definitions/tapi.oam.OamService" + $ref: "#/definitions/tapi.eth.EthCfmMaintenanceAssociation" responses: 201: description: "Object created" @@ -10902,8 +11634,9 @@ paths: description: "Object already exists" put: tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamService" + - "tapi-eth" + summary: "creates or updates tapi.eth.EthCfmMaintenanceAssociation" + description: "none" parameters: - name: "uuid" in: "path" @@ -10911,11 +11644,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.oam.OamService.body-param" - description: "tapi.oam.OamService to be added or updated" + name: "tapi.eth.EthCfmMaintenanceAssociation.body-param" + description: "tapi.eth.EthCfmMaintenanceAssociation to be added or updated" required: false schema: - $ref: "#/definitions/tapi.oam.OamService" + $ref: "#/definitions/tapi.eth.EthCfmMaintenanceAssociation" responses: 201: description: "Object created" @@ -10925,8 +11658,9 @@ paths: description: "Object modified" delete: tags: - - "tapi-oam" - description: "removes tapi.oam.OamService" + - "tapi-eth" + summary: "removes tapi.eth.EthCfmMaintenanceAssociation" + description: "none" parameters: - name: "uuid" in: "path" @@ -10938,74 +11672,44 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/end-point/: - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamServiceEndPoint.body-param" - description: "tapi.oam.OamServiceEndPoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/: + /data/context/oam-context/oam-service={uuid}/eth-oam-service/eth-cfm-maintenance-association/maintenance-association-name/: get: tags: - - "tapi-oam" - description: "returns tapi.oam.OamServiceEndPoint" + - "tapi-eth" + summary: "returns tapi.eth.MaintenanceAssociationName" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ The Maintenance Association name and name format choice." parameters: - name: "uuid" in: "path" description: "Id of oam-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" responses: 200: - description: "tapi.oam.OamServiceEndPoint" + description: "tapi.eth.MaintenanceAssociationName" schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" + $ref: "#/definitions/tapi.eth.MaintenanceAssociationName" 400: description: "Internal error" post: tags: - - "tapi-oam" - description: "creates tapi.oam.OamServiceEndPoint" + - "tapi-eth" + summary: "creates tapi.eth.MaintenanceAssociationName" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ The Maintenance Association name and name format choice." parameters: - name: "uuid" in: "path" description: "Id of oam-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - in: "body" - name: "tapi.oam.OamServiceEndPoint.body-param" - description: "tapi.oam.OamServiceEndPoint to be added to list" + name: "tapi.eth.MaintenanceAssociationName.body-param" + description: "tapi.eth.MaintenanceAssociationName to be added to list" required: false schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" + $ref: "#/definitions/tapi.eth.MaintenanceAssociationName" responses: 201: description: "Object created" @@ -11015,25 +11719,22 @@ paths: description: "Object already exists" put: tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamServiceEndPoint" + - "tapi-eth" + summary: "creates or updates tapi.eth.MaintenanceAssociationName" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ The Maintenance Association name and name format choice." parameters: - name: "uuid" in: "path" description: "Id of oam-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - in: "body" - name: "tapi.oam.OamServiceEndPoint.body-param" - description: "tapi.oam.OamServiceEndPoint to be added or updated" + name: "tapi.eth.MaintenanceAssociationName.body-param" + description: "tapi.eth.MaintenanceAssociationName to be added or updated" required: false schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" + $ref: "#/definitions/tapi.eth.MaintenanceAssociationName" responses: 201: description: "Object created" @@ -11043,69 +11744,57 @@ paths: description: "Object modified" delete: tags: - - "tapi-oam" - description: "removes tapi.oam.OamServiceEndPoint" + - "tapi-eth" + summary: "removes tapi.eth.MaintenanceAssociationName" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ The Maintenance Association name and name format choice." parameters: - name: "uuid" in: "path" description: "Id of oam-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/connectivity-service-end-point/: + /data/context/oam-context/oam-service={uuid}/eth-oam-service/eth-cfm-maintenance-domain/: get: tags: - - "tapi-oam" - description: "returns tapi.connectivity.ConnectivityServiceEndPointRef" + - "tapi-eth" + summary: "returns tapi.eth.EthCfmMaintenanceDomain" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" responses: 200: - description: "tapi.connectivity.ConnectivityServiceEndPointRef" + description: "tapi.eth.EthCfmMaintenanceDomain" schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" + $ref: "#/definitions/tapi.eth.EthCfmMaintenanceDomain" 400: description: "Internal error" post: tags: - - "tapi-oam" - description: "creates tapi.connectivity.ConnectivityServiceEndPointRef" + - "tapi-eth" + summary: "creates tapi.eth.EthCfmMaintenanceDomain" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - in: "body" - name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" - description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ - \ to list" + name: "tapi.eth.EthCfmMaintenanceDomain.body-param" + description: "tapi.eth.EthCfmMaintenanceDomain to be added to list" required: false schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" + $ref: "#/definitions/tapi.eth.EthCfmMaintenanceDomain" responses: 201: description: "Object created" @@ -11115,26 +11804,21 @@ paths: description: "Object already exists" put: tags: - - "tapi-oam" - description: "creates or updates tapi.connectivity.ConnectivityServiceEndPointRef" + - "tapi-eth" + summary: "creates or updates tapi.eth.EthCfmMaintenanceDomain" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - in: "body" - name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" - description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ - \ or updated" + name: "tapi.eth.EthCfmMaintenanceDomain.body-param" + description: "tapi.eth.EthCfmMaintenanceDomain to be added or updated" required: false schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" + $ref: "#/definitions/tapi.eth.EthCfmMaintenanceDomain" responses: 201: description: "Object created" @@ -11144,147 +11828,136 @@ paths: description: "Object modified" delete: tags: - - "tapi-oam" - description: "removes tapi.connectivity.ConnectivityServiceEndPointRef" - parameters: + - "tapi-eth" + summary: "removes tapi.eth.EthCfmMaintenanceDomain" + description: "none" + parameters: - name: "uuid" in: "path" description: "Id of oam-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/mep/: + /data/context/oam-context/oam-service={uuid}/eth-oam-service/eth-meg-common/: get: tags: - - "tapi-oam" - description: "returns tapi.oam.MepRef" + - "tapi-eth" + summary: "returns tapi.eth.EthMegCommon" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" responses: 200: - description: "tapi.oam.MepRef" + description: "tapi.eth.EthMegCommon" schema: - $ref: "#/definitions/tapi.oam.MepRef" + $ref: "#/definitions/tapi.eth.EthMegCommon" 400: description: "Internal error" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/mip/: - get: + post: tags: - - "tapi-oam" - description: "returns tapi.oam.MipRef" + - "tapi-eth" + summary: "creates tapi.eth.EthMegCommon" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" + - in: "body" + name: "tapi.eth.EthMegCommon.body-param" + description: "tapi.eth.EthMegCommon to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthMegCommon" responses: - 200: - description: "tapi.oam.MipRef" - schema: - $ref: "#/definitions/tapi.oam.MipRef" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/name/: - post: + 409: + description: "Object already exists" + put: tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" + - "tapi-eth" + summary: "creates or updates tapi.eth.EthMegCommon" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.eth.EthMegCommon.body-param" + description: "tapi.eth.EthMegCommon to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.eth.EthMegCommon" responses: 201: description: "Object created" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/name={value-name}/: - get: + 204: + description: "Object modified" + delete: tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" + - "tapi-eth" + summary: "removes tapi.eth.EthMegCommon" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-service={uuid}/meg/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.MegRef" + description: "none" + parameters: + - name: "uuid" in: "path" - description: "Id of name" + description: "Id of oam-service" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.oam.MegRef" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.oam.MegRef" 400: description: "Internal error" + /data/context/oam-context/oam-service={uuid}/name/: post: tags: - "tapi-oam" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of oam-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - in: "body" name: "tapi.common.NameAndValue.body-param" description: "tapi.common.NameAndValue to be added to list" @@ -11298,19 +11971,43 @@ paths: description: "Internal error" 409: description: "Object already exists" - put: + /data/context/oam-context/oam-service={uuid}/name={value-name}/: + get: tags: - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of oam-service" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of end-point" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" required: true type: "string" - name: "value-name" @@ -11334,18 +12031,16 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of oam-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - name: "value-name" in: "path" description: "Id of name" @@ -11356,33 +12051,37 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/service-interface-point/: - get: + /data/context/oam-context/oam-service={uuid}/oam-service-point/: + post: tags: - "tapi-oam" - description: "returns tapi.common.ServiceInterfacePointRef" + summary: "creates tapi.oam.oamservice.OamServicePoint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" + - in: "body" + name: "tapi.oam.oamservice.OamServicePoint.body-param" + description: "tapi.oam.oamservice.OamServicePoint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.oamservice.OamServicePoint" responses: - 200: - description: "tapi.common.ServiceInterfacePointRef" - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/: + get: tags: - "tapi-oam" - description: "creates tapi.common.ServiceInterfacePointRef" + summary: "returns tapi.oam.oamservice.OamServicePoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -11391,26 +12090,21 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of oam-service-point" required: true type: "string" - - in: "body" - name: "tapi.common.ServiceInterfacePointRef.body-param" - description: "tapi.common.ServiceInterfacePointRef to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" responses: - 201: - description: "Object created" + 200: + description: "tapi.oam.oamservice.OamServicePoint" + schema: + $ref: "#/definitions/tapi.oam.oamservice.OamServicePoint" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-oam" - description: "creates or updates tapi.common.ServiceInterfacePointRef" + summary: "creates or updates tapi.oam.oamservice.OamServicePoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -11419,15 +12113,15 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of oam-service-point" required: true type: "string" - in: "body" - name: "tapi.common.ServiceInterfacePointRef.body-param" - description: "tapi.common.ServiceInterfacePointRef to be added or updated" + name: "tapi.oam.oamservice.OamServicePoint.body-param" + description: "tapi.oam.oamservice.OamServicePoint to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + $ref: "#/definitions/tapi.oam.oamservice.OamServicePoint" responses: 201: description: "Object created" @@ -11438,7 +12132,8 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.common.ServiceInterfacePointRef" + summary: "removes tapi.oam.oamservice.OamServicePoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -11447,7 +12142,7 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of oam-service-point" required: true type: "string" responses: @@ -11455,92 +12150,53 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/meg/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.MegRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.MegRef" - schema: - $ref: "#/definitions/tapi.oam.MegRef" - 400: - description: "Internal error" - /data/context/oam-context/oam-service={uuid}/name/: - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-service={uuid}/name={value-name}/: + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/connectivity-service-end-point/: get: tags: - "tapi-oam" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-service" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of name" + description: "Id of oam-service-point" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.connectivity.ConnectivityServiceEndPointRef" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" 400: description: "Internal error" post: tags: - "tapi-oam" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-service" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of name" + description: "Id of oam-service-point" required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ to list" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" responses: 201: description: "Object created" @@ -11551,24 +12207,26 @@ paths: put: tags: - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" + summary: "creates or updates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-service" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of name" + description: "Id of oam-service-point" required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ or updated" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" responses: 201: description: "Object created" @@ -11579,16 +12237,17 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-service" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of name" + description: "Id of oam-service-point" required: true type: "string" responses: @@ -11596,40 +12255,52 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/oam-profile/: + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/eth-oam-mep-service-point/: get: tags: - - "tapi-oam" - description: "returns tapi.oam.OamProfileRef" + - "tapi-eth" + summary: "returns tapi.eth.EthOamMepServicePoint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" responses: 200: - description: "tapi.oam.OamProfileRef" + description: "tapi.eth.EthOamMepServicePoint" schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" + $ref: "#/definitions/tapi.eth.EthOamMepServicePoint" 400: description: "Internal error" post: tags: - - "tapi-oam" - description: "creates tapi.oam.OamProfileRef" + - "tapi-eth" + summary: "creates tapi.eth.EthOamMepServicePoint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-service" required: true type: "string" - - in: "body" - name: "tapi.oam.OamProfileRef.body-param" - description: "tapi.oam.OamProfileRef to be added to list" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthOamMepServicePoint.body-param" + description: "tapi.eth.EthOamMepServicePoint to be added to list" required: false schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" + $ref: "#/definitions/tapi.eth.EthOamMepServicePoint" responses: 201: description: "Object created" @@ -11639,20 +12310,26 @@ paths: description: "Object already exists" put: tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamProfileRef" + - "tapi-eth" + summary: "creates or updates tapi.eth.EthOamMepServicePoint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" - in: "body" - name: "tapi.oam.OamProfileRef.body-param" - description: "tapi.oam.OamProfileRef to be added or updated" + name: "tapi.eth.EthOamMepServicePoint.body-param" + description: "tapi.eth.EthOamMepServicePoint to be added or updated" required: false schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" + $ref: "#/definitions/tapi.eth.EthOamMepServicePoint" responses: 201: description: "Object created" @@ -11662,44 +12339,71 @@ paths: description: "Object modified" delete: tags: - - "tapi-oam" - description: "removes tapi.oam.OamProfileRef" + - "tapi-eth" + summary: "removes tapi.eth.EthOamMepServicePoint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/: + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/eth-oam-mep-service-point/eth-mep-common/: get: tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathComputationContext" - parameters: [] + - "tapi-eth" + summary: "returns tapi.eth.EthMepCommon" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" responses: 200: - description: "tapi.path.computation.PathComputationContext" + description: "tapi.eth.EthMepCommon" schema: - $ref: "#/definitions/tapi.path.computation.PathComputationContext" + $ref: "#/definitions/tapi.eth.EthMepCommon" 400: description: "Internal error" post: tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathComputationContext" + - "tapi-eth" + summary: "creates tapi.eth.EthMepCommon" + description: "none" parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" - in: "body" - name: "tapi.path.computation.PathComputationContext.body-param" - description: "tapi.path.computation.PathComputationContext to be added to\ - \ list" + name: "tapi.eth.EthMepCommon.body-param" + description: "tapi.eth.EthMepCommon to be added to list" required: false schema: - $ref: "#/definitions/tapi.path.computation.PathComputationContext" + $ref: "#/definitions/tapi.eth.EthMepCommon" responses: 201: description: "Object created" @@ -11709,16 +12413,26 @@ paths: description: "Object already exists" put: tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathComputationContext" + - "tapi-eth" + summary: "creates or updates tapi.eth.EthMepCommon" + description: "none" parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" - in: "body" - name: "tapi.path.computation.PathComputationContext.body-param" - description: "tapi.path.computation.PathComputationContext to be added or\ - \ updated" + name: "tapi.eth.EthMepCommon.body-param" + description: "tapi.eth.EthMepCommon to be added or updated" required: false schema: - $ref: "#/definitions/tapi.path.computation.PathComputationContext" + $ref: "#/definitions/tapi.eth.EthMepCommon" responses: 201: description: "Object created" @@ -11728,69 +12442,71 @@ paths: description: "Object modified" delete: tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.PathComputationContext" - parameters: [] + - "tapi-eth" + summary: "removes tapi.eth.EthMepCommon" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathComputationService" - parameters: - - in: "body" - name: "tapi.path.computation.PathComputationService.body-param" - description: "tapi.path.computation.PathComputationService to be added to\ - \ list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/: + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/eth-oam-mep-service-point/eth-mep-sink/: get: tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathComputationService" + - "tapi-eth" + summary: "returns tapi.eth.EthMepSink" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" required: true type: "string" responses: 200: - description: "tapi.path.computation.PathComputationService" + description: "tapi.eth.EthMepSink" schema: - $ref: "#/definitions/tapi.path.computation.PathComputationService" + $ref: "#/definitions/tapi.eth.EthMepSink" 400: description: "Internal error" post: tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathComputationService" + - "tapi-eth" + summary: "creates tapi.eth.EthMepSink" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" required: true type: "string" - in: "body" - name: "tapi.path.computation.PathComputationService.body-param" - description: "tapi.path.computation.PathComputationService to be added to\ - \ list" + name: "tapi.eth.EthMepSink.body-param" + description: "tapi.eth.EthMepSink to be added to list" required: false schema: - $ref: "#/definitions/tapi.path.computation.PathComputationService" + $ref: "#/definitions/tapi.eth.EthMepSink" responses: 201: description: "Object created" @@ -11800,21 +12516,26 @@ paths: description: "Object already exists" put: tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathComputationService" + - "tapi-eth" + summary: "creates or updates tapi.eth.EthMepSink" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" required: true type: "string" - in: "body" - name: "tapi.path.computation.PathComputationService.body-param" - description: "tapi.path.computation.PathComputationService to be added or\ - \ updated" + name: "tapi.eth.EthMepSink.body-param" + description: "tapi.eth.EthMepSink to be added or updated" required: false schema: - $ref: "#/definitions/tapi.path.computation.PathComputationService" + $ref: "#/definitions/tapi.eth.EthMepSink" responses: 201: description: "Object created" @@ -11824,12 +12545,18 @@ paths: description: "Object modified" delete: tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.PathComputationService" + - "tapi-eth" + summary: "removes tapi.eth.EthMepSink" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" required: true type: "string" responses: @@ -11837,74 +12564,77 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point/: - post: + ? /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/eth-oam-mep-service-point/eth-mep-sink/bandwidth-report/ + : get: tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathServiceEndPoint" + - "tapi-eth" + summary: "returns tapi.eth.BandwidthReport" + description: "This attribute models the content of the bandwidth report received\ + \ by the MEP Sink from the peer MEP Source." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" required: true type: "string" - - in: "body" - name: "tapi.path.computation.PathServiceEndPoint.body-param" - description: "tapi.path.computation.PathServiceEndPoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" responses: - 201: - description: "Object created" + 200: + description: "tapi.eth.BandwidthReport" + schema: + $ref: "#/definitions/tapi.eth.BandwidthReport" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/: + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/eth-oam-mep-service-point/eth-mep-source/: get: tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathServiceEndPoint" + - "tapi-eth" + summary: "returns tapi.eth.EthMepSource" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of oam-service-point" required: true type: "string" responses: 200: - description: "tapi.path.computation.PathServiceEndPoint" + description: "tapi.eth.EthMepSource" schema: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + $ref: "#/definitions/tapi.eth.EthMepSource" 400: description: "Internal error" post: tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathServiceEndPoint" + - "tapi-eth" + summary: "creates tapi.eth.EthMepSource" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of oam-service-point" required: true type: "string" - in: "body" - name: "tapi.path.computation.PathServiceEndPoint.body-param" - description: "tapi.path.computation.PathServiceEndPoint to be added to list" + name: "tapi.eth.EthMepSource.body-param" + description: "tapi.eth.EthMepSource to be added to list" required: false schema: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + $ref: "#/definitions/tapi.eth.EthMepSource" responses: 201: description: "Object created" @@ -11914,25 +12644,26 @@ paths: description: "Object already exists" put: tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathServiceEndPoint" + - "tapi-eth" + summary: "creates or updates tapi.eth.EthMepSource" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of oam-service-point" required: true type: "string" - in: "body" - name: "tapi.path.computation.PathServiceEndPoint.body-param" - description: "tapi.path.computation.PathServiceEndPoint to be added or updated" + name: "tapi.eth.EthMepSource.body-param" + description: "tapi.eth.EthMepSource to be added or updated" required: false schema: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + $ref: "#/definitions/tapi.eth.EthMepSource" responses: 201: description: "Object created" @@ -11942,17 +12673,18 @@ paths: description: "Object modified" delete: tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.PathServiceEndPoint" + - "tapi-eth" + summary: "removes tapi.eth.EthMepSource" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of oam-service-point" required: true type: "string" responses: @@ -11960,50 +12692,52 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/: + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/eth-oam-mip-service-point/: get: tags: - - "tapi-path-computation" - description: "returns tapi.common.Capacity" + - "tapi-eth" + summary: "returns tapi.eth.EthOamMipServicePoint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of oam-service-point" required: true type: "string" responses: 200: - description: "tapi.common.Capacity" + description: "tapi.eth.EthOamMipServicePoint" schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.eth.EthOamMipServicePoint" 400: description: "Internal error" post: tags: - - "tapi-path-computation" - description: "creates tapi.common.Capacity" + - "tapi-eth" + summary: "creates tapi.eth.EthOamMipServicePoint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of oam-service-point" required: true type: "string" - in: "body" - name: "tapi.common.Capacity.body-param" - description: "tapi.common.Capacity to be added to list" + name: "tapi.eth.EthOamMipServicePoint.body-param" + description: "tapi.eth.EthOamMipServicePoint to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.eth.EthOamMipServicePoint" responses: 201: description: "Object created" @@ -12013,25 +12747,26 @@ paths: description: "Object already exists" put: tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.Capacity" + - "tapi-eth" + summary: "creates or updates tapi.eth.EthOamMipServicePoint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of oam-service-point" required: true type: "string" - in: "body" - name: "tapi.common.Capacity.body-param" - description: "tapi.common.Capacity to be added or updated" + name: "tapi.eth.EthOamMipServicePoint.body-param" + description: "tapi.eth.EthOamMipServicePoint to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.eth.EthOamMipServicePoint" responses: 201: description: "Object created" @@ -12041,17 +12776,18 @@ paths: description: "Object modified" delete: tags: - - "tapi-path-computation" - description: "removes tapi.common.Capacity" + - "tapi-eth" + summary: "removes tapi.eth.EthOamMipServicePoint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of oam-service-point" required: true type: "string" responses: @@ -12059,50 +12795,52 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/: + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/eth-oam-mip-service-point/eth-mip-common/: get: tags: - - "tapi-path-computation" - description: "returns tapi.common.BandwidthProfile" + - "tapi-eth" + summary: "returns tapi.eth.EthMipCommon" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of oam-service-point" required: true type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.eth.EthMipCommon" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.eth.EthMipCommon" 400: description: "Internal error" post: tags: - - "tapi-path-computation" - description: "creates tapi.common.BandwidthProfile" + - "tapi-eth" + summary: "creates tapi.eth.EthMipCommon" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of oam-service-point" required: true type: "string" - in: "body" - name: "tapi.common.BandwidthProfile.body-param" - description: "tapi.common.BandwidthProfile to be added to list" + name: "tapi.eth.EthMipCommon.body-param" + description: "tapi.eth.EthMipCommon to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.eth.EthMipCommon" responses: 201: description: "Object created" @@ -12112,25 +12850,26 @@ paths: description: "Object already exists" put: tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.BandwidthProfile" + - "tapi-eth" + summary: "creates or updates tapi.eth.EthMipCommon" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of oam-service-point" required: true type: "string" - in: "body" - name: "tapi.common.BandwidthProfile.body-param" - description: "tapi.common.BandwidthProfile to be added or updated" + name: "tapi.eth.EthMipCommon.body-param" + description: "tapi.eth.EthMipCommon to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.eth.EthMipCommon" responses: 201: description: "Object created" @@ -12140,17 +12879,18 @@ paths: description: "Object modified" delete: tags: - - "tapi-path-computation" - description: "removes tapi.common.BandwidthProfile" + - "tapi-eth" + summary: "removes tapi.eth.EthMipCommon" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of oam-service-point" required: true type: "string" responses: @@ -12158,177 +12898,146 @@ paths: description: "Internal error" 204: description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-burst-size/ - : get: + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/mep/: + get: tags: - - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" + - "tapi-oam" + summary: "returns tapi.oam.MepRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of oam-service-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.oam.MepRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.oam.MepRef" 400: description: "Internal error" - post: + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/mip/: + get: tags: - - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" + - "tapi-oam" + summary: "returns tapi.oam.MipRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of oam-service-point" required: true type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.oam.MipRef" + schema: + $ref: "#/definitions/tapi.oam.MipRef" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/name/: + post: tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" + - "tapi-oam" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of oam-service-point" required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + 409: + description: "Object already exists" + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/name={value-name}/: + get: tags: - - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" + description: "Id of oam-service-point" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of end-point" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: + put: tags: - - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" + - "tapi-oam" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" + description: "Id of oam-service-point" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of end-point" + description: "Id of name" required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -12338,17 +13047,25 @@ paths: description: "Object modified" delete: tags: - - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" + - "tapi-oam" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of oam-service-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" required: true type: "string" responses: @@ -12356,50 +13073,52 @@ paths: description: "Internal error" 204: description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-burst-size/ - : get: + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/service-interface-point/: + get: tags: - - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" + - "tapi-oam" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of oam-service-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.ServiceInterfacePointRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" 400: description: "Internal error" post: tags: - - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" + - "tapi-oam" + summary: "creates tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of oam-service-point" required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.common.ServiceInterfacePointRef.body-param" + description: "tapi.common.ServiceInterfacePointRef to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" responses: 201: description: "Object created" @@ -12409,25 +13128,26 @@ paths: description: "Object already exists" put: tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" + - "tapi-oam" + summary: "creates or updates tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of oam-service-point" required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.common.ServiceInterfacePointRef.body-param" + description: "tapi.common.ServiceInterfacePointRef to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" responses: 201: description: "Object created" @@ -12437,17 +13157,18 @@ paths: description: "Object modified" delete: tags: - - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" + - "tapi-oam" + summary: "removes tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of oam-service-point" required: true type: "string" responses: @@ -12455,50 +13176,33 @@ paths: description: "Internal error" 204: description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-information-rate/ - : get: + /data/context/path-computation-context/: + get: tags: - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" + summary: "returns tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" + parameters: [] responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.path.computation.PathComputationContext" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.path.computation.PathComputationContext" 400: description: "Internal error" post: tags: - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" + summary: "creates tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.path.computation.PathComputationContext.body-param" + description: "tapi.path.computation.PathComputationContext to be added to\ + \ list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.path.computation.PathComputationContext" responses: 201: description: "Object created" @@ -12509,24 +13213,16 @@ paths: put: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.path.computation.PathComputationContext.body-param" + description: "tapi.path.computation.PathComputationContext to be added or\ + \ updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.path.computation.PathComputationContext" responses: 201: description: "Object created" @@ -12537,106 +13233,126 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" + summary: "removes tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" + parameters: [] responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/total-size/: - get: - tags: + /data/context/path-computation-context/path-comp-service/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.path.computation.PathComputationService" + description: "none" + parameters: + - in: "body" + name: "tapi.path.computation.PathComputationService.body-param" + description: "tapi.path.computation.PathComputationService to be added to\ + \ list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.PathComputationService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/: + get: + tags: - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.path.computation.PathComputationService" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.path.computation.PathComputationService" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.path.computation.PathComputationService" 400: description: "Internal error" - post: + put: tags: - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" + summary: "creates or updates tapi.path.computation.PathComputationService" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.path.computation.PathComputationService.body-param" + description: "tapi.path.computation.PathComputationService to be added or\ + \ updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.path.computation.PathComputationService" responses: 201: description: "Object created" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + 204: + description: "Object modified" + delete: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" + summary: "removes tapi.path.computation.PathComputationService" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/end-point/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.path.computation.PathServiceEndPoint" + description: "none" + parameters: + - name: "uuid" in: "path" - description: "Id of end-point" + description: "Id of path-comp-service" required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.path.computation.PathServiceEndPoint.body-param" + description: "tapi.path.computation.PathServiceEndPoint to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" responses: 201: description: "Object created" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/: + get: tags: - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" + summary: "returns tapi.path.computation.PathServiceEndPoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -12649,15 +13365,17 @@ paths: required: true type: "string" responses: + 200: + description: "tapi.path.computation.PathServiceEndPoint" + schema: + $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/name/: - post: + put: tags: - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" + summary: "creates or updates tapi.path.computation.PathServiceEndPoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -12670,23 +13388,23 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.path.computation.PathServiceEndPoint.body-param" + description: "tapi.path.computation.PathServiceEndPoint to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" responses: 201: description: "Object created" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/name={value-name}/: - get: + 204: + description: "Object modified" + delete: tags: - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" + summary: "removes tapi.path.computation.PathServiceEndPoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -12698,22 +13416,40 @@ paths: description: "Id of end-point" required: true type: "string" - - name: "value-name" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.Capacity" + description: "none" + parameters: + - name: "uuid" in: "path" - description: "Id of name" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" post: tags: - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" @@ -12725,17 +13461,12 @@ paths: description: "Id of end-point" required: true type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.common.Capacity.body-param" + description: "tapi.common.Capacity to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.common.Capacity" responses: 201: description: "Object created" @@ -12746,7 +13477,8 @@ paths: put: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" + summary: "creates or updates tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" @@ -12758,17 +13490,12 @@ paths: description: "Id of end-point" required: true type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" + name: "tapi.common.Capacity.body-param" + description: "tapi.common.Capacity to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.common.Capacity" responses: 201: description: "Object created" @@ -12779,7 +13506,8 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" @@ -12791,21 +13519,18 @@ paths: description: "Id of end-point" required: true type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/service-interface-point/: + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/total-size/: get: tags: - "tapi-path-computation" - description: "returns tapi.common.ServiceInterfacePointRef" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -12819,28 +13544,34 @@ paths: type: "string" responses: 200: - description: "tapi.common.ServiceInterfacePointRef" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/name/: post: tags: - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.common.CapacityValue.body-param" + description: "tapi.common.CapacityValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.common.CapacityValue" responses: 201: description: "Object created" @@ -12848,75 +13579,80 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/name={value-name}/: - get: + put: tags: - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" + summary: "creates or updates tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of name" + description: "Id of end-point" required: true type: "string" + - in: "body" + name: "tapi.common.CapacityValue.body-param" + description: "tapi.common.CapacityValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.CapacityValue" responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" + 201: + description: "Object created" 400: description: "Internal error" - post: + 204: + description: "Object modified" + delete: tags: - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" + summary: "removes tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of name" + description: "Id of end-point" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" responses: - 201: - description: "Object created" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/name/: + post: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of name" + description: "Id of end-point" required: true type: "string" - in: "body" name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" + description: "tapi.common.NameAndValue to be added to list" required: false schema: $ref: "#/definitions/tapi.common.NameAndValue" @@ -12925,62 +13661,149 @@ paths: description: "Object created" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/name={value-name}/: + get: tags: - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" - name: "value-name" in: "path" description: "Id of name" required: true type: "string" responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/objective-function/: - get: + put: tags: - "tapi-path-computation" - description: "returns tapi.path.computation.PathObjectiveFunction" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - responses: - 200: - description: "tapi.path.computation.PathObjectiveFunction" - schema: - $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" - 400: - description: "Internal error" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/service-interface-point/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.ServiceInterfacePointRef" + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + 400: + description: "Internal error" post: tags: - "tapi-path-computation" - description: "creates tapi.path.computation.PathObjectiveFunction" + summary: "creates tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" - in: "body" - name: "tapi.path.computation.PathObjectiveFunction.body-param" - description: "tapi.path.computation.PathObjectiveFunction to be added to list" + name: "tapi.common.ServiceInterfacePointRef.body-param" + description: "tapi.common.ServiceInterfacePointRef to be added to list" required: false schema: - $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" responses: 201: description: "Object created" @@ -12991,19 +13814,25 @@ paths: put: tags: - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathObjectiveFunction" + summary: "creates or updates tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" - in: "body" - name: "tapi.path.computation.PathObjectiveFunction.body-param" - description: "tapi.path.computation.PathObjectiveFunction to be added or updated" + name: "tapi.common.ServiceInterfacePointRef.body-param" + description: "tapi.common.ServiceInterfacePointRef to be added or updated" required: false schema: - $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" responses: 201: description: "Object created" @@ -13014,23 +13843,32 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.path.computation.PathObjectiveFunction" + summary: "removes tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/objective-function/name/: + /data/context/path-computation-context/path-comp-service={uuid}/name/: post: tags: - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -13050,11 +13888,14 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/objective-function/name={value-name}/: + /data/context/path-computation-context/path-comp-service={uuid}/name={value-name}/: get: tags: - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -13073,38 +13914,13 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -13132,7 +13948,10 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -13149,11 +13968,12 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/: + /data/context/path-computation-context/path-comp-service={uuid}/objective-function/: get: tags: - "tapi-path-computation" - description: "returns tapi.path.computation.PathOptimizationConstraint" + summary: "returns tapi.path.computation.PathObjectiveFunction" + description: "none" parameters: - name: "uuid" in: "path" @@ -13162,15 +13982,16 @@ paths: type: "string" responses: 200: - description: "tapi.path.computation.PathOptimizationConstraint" + description: "tapi.path.computation.PathObjectiveFunction" schema: - $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" + $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" 400: description: "Internal error" post: tags: - "tapi-path-computation" - description: "creates tapi.path.computation.PathOptimizationConstraint" + summary: "creates tapi.path.computation.PathObjectiveFunction" + description: "none" parameters: - name: "uuid" in: "path" @@ -13178,12 +13999,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.path.computation.PathOptimizationConstraint.body-param" - description: "tapi.path.computation.PathOptimizationConstraint to be added\ - \ to list" + name: "tapi.path.computation.PathObjectiveFunction.body-param" + description: "tapi.path.computation.PathObjectiveFunction to be added to list" required: false schema: - $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" + $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" responses: 201: description: "Object created" @@ -13194,7 +14014,8 @@ paths: put: tags: - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathOptimizationConstraint" + summary: "creates or updates tapi.path.computation.PathObjectiveFunction" + description: "none" parameters: - name: "uuid" in: "path" @@ -13202,12 +14023,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.path.computation.PathOptimizationConstraint.body-param" - description: "tapi.path.computation.PathOptimizationConstraint to be added\ - \ or updated" + name: "tapi.path.computation.PathObjectiveFunction.body-param" + description: "tapi.path.computation.PathObjectiveFunction to be added or updated" required: false schema: - $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" + $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" responses: 201: description: "Object created" @@ -13218,7 +14038,8 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.path.computation.PathOptimizationConstraint" + summary: "removes tapi.path.computation.PathObjectiveFunction" + description: "none" parameters: - name: "uuid" in: "path" @@ -13230,11 +14051,14 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name/: + /data/context/path-computation-context/path-comp-service={uuid}/objective-function/name/: post: tags: - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -13254,11 +14078,14 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name={value-name}/: + /data/context/path-computation-context/path-comp-service={uuid}/objective-function/name={value-name}/: get: tags: - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -13277,38 +14104,13 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -13336,7 +14138,10 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -13353,34 +14158,12 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/path={path-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "path-uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/: + /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/: get: tags: - "tapi-path-computation" - description: "returns tapi.path.computation.RoutingConstraint" + summary: "returns tapi.path.computation.PathOptimizationConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -13389,15 +14172,16 @@ paths: type: "string" responses: 200: - description: "tapi.path.computation.RoutingConstraint" + description: "tapi.path.computation.PathOptimizationConstraint" schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" 400: description: "Internal error" post: tags: - "tapi-path-computation" - description: "creates tapi.path.computation.RoutingConstraint" + summary: "creates tapi.path.computation.PathOptimizationConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -13405,11 +14189,12 @@ paths: required: true type: "string" - in: "body" - name: "tapi.path.computation.RoutingConstraint.body-param" - description: "tapi.path.computation.RoutingConstraint to be added to list" + name: "tapi.path.computation.PathOptimizationConstraint.body-param" + description: "tapi.path.computation.PathOptimizationConstraint to be added\ + \ to list" required: false schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" responses: 201: description: "Object created" @@ -13420,7 +14205,8 @@ paths: put: tags: - "tapi-path-computation" - description: "creates or updates tapi.path.computation.RoutingConstraint" + summary: "creates or updates tapi.path.computation.PathOptimizationConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -13428,11 +14214,12 @@ paths: required: true type: "string" - in: "body" - name: "tapi.path.computation.RoutingConstraint.body-param" - description: "tapi.path.computation.RoutingConstraint to be added or updated" + name: "tapi.path.computation.PathOptimizationConstraint.body-param" + description: "tapi.path.computation.PathOptimizationConstraint to be added\ + \ or updated" required: false schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" responses: 201: description: "Object created" @@ -13443,7 +14230,8 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.path.computation.RoutingConstraint" + summary: "removes tapi.path.computation.PathOptimizationConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -13455,11 +14243,14 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic/: + /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name/: post: tags: - "tapi-path-computation" - description: "creates tapi.topology.CostCharacteristic" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -13467,11 +14258,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -13479,42 +14270,204 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic={cost-name}/: + /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name={value-name}/: get: tags: - "tapi-path-computation" - description: "returns tapi.topology.CostCharacteristic" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "cost-name" + - name: "value-name" in: "path" - description: "Id of cost-characteristic" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.topology.CostCharacteristic" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: + put: tags: - "tapi-path-computation" - description: "creates tapi.topology.CostCharacteristic" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "cost-name" + - name: "value-name" in: "path" - description: "Id of cost-characteristic" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/path={path-uuid}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.path.computation.PathRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "path-uuid" + in: "path" + description: "Id of path" + required: true + type: "string" + responses: + 200: + description: "tapi.path.computation.PathRef" + schema: + $ref: "#/definitions/tapi.path.computation.PathRef" + 400: + description: "Internal error" + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + responses: + 200: + description: "tapi.path.computation.RoutingConstraint" + schema: + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + 400: + description: "Internal error" + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.RoutingConstraint.body-param" + description: "tapi.path.computation.RoutingConstraint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.RoutingConstraint.body-param" + description: "tapi.path.computation.RoutingConstraint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" required: true type: "string" - in: "body" @@ -13530,10 +14483,37 @@ paths: description: "Internal error" 409: description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic={cost-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" put: tags: - "tapi-path-computation" - description: "creates or updates tapi.topology.CostCharacteristic" + summary: "creates or updates tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" @@ -13561,7 +14541,9 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.topology.CostCharacteristic" + summary: "removes tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" @@ -13582,7 +14564,9 @@ paths: post: tags: - "tapi-path-computation" - description: "creates tapi.topology.LatencyCharacteristic" + summary: "creates tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" @@ -13606,7 +14590,9 @@ paths: : get: tags: - "tapi-path-computation" - description: "returns tapi.topology.LatencyCharacteristic" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" @@ -13625,38 +14611,12 @@ paths: $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-path-computation" - description: "creates or updates tapi.topology.LatencyCharacteristic" + summary: "creates or updates tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" @@ -13684,7 +14644,9 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.topology.LatencyCharacteristic" + summary: "removes tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" @@ -13705,7 +14667,8 @@ paths: post: tags: - "tapi-path-computation" - description: "creates tapi.topology.RiskCharacteristic" + summary: "creates tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" @@ -13729,7 +14692,8 @@ paths: : get: tags: - "tapi-path-computation" - description: "returns tapi.topology.RiskCharacteristic" + summary: "returns tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" @@ -13748,10 +14712,11 @@ paths: $ref: "#/definitions/tapi.topology.RiskCharacteristic" 400: description: "Internal error" - post: + put: tags: - "tapi-path-computation" - description: "creates tapi.topology.RiskCharacteristic" + summary: "creates or updates tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" @@ -13765,7 +14730,7 @@ paths: type: "string" - in: "body" name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added to list" + description: "tapi.topology.RiskCharacteristic to be added or updated" required: false schema: $ref: "#/definitions/tapi.topology.RiskCharacteristic" @@ -13774,12 +14739,13 @@ paths: description: "Object created" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + 204: + description: "Object modified" + delete: tags: - "tapi-path-computation" - description: "creates or updates tapi.topology.RiskCharacteristic" + summary: "removes tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" @@ -13791,50 +14757,53 @@ paths: description: "Id of risk-diversity-characteristic" required: true type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" responses: - 201: - description: "Object created" 400: description: "Internal error" 204: - description: "Object modified" - delete: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/: + post: tags: - "tapi-path-computation" - description: "removes tapi.topology.RiskCharacteristic" + summary: "creates tapi.path.computation.TopologyConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" + - in: "body" + name: "tapi.path.computation.TopologyConstraint.body-param" + description: "tapi.path.computation.TopologyConstraint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" responses: + 201: + description: "Object created" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/: + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint={local-id}/: get: tags: - "tapi-path-computation" - description: "returns tapi.path.computation.TopologyConstraint" + summary: "returns tapi.path.computation.TopologyConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" responses: 200: description: "tapi.path.computation.TopologyConstraint" @@ -13842,42 +14811,25 @@ paths: $ref: "#/definitions/tapi.path.computation.TopologyConstraint" 400: description: "Internal error" - post: + put: tags: - "tapi-path-computation" - description: "creates tapi.path.computation.TopologyConstraint" + summary: "creates or updates tapi.path.computation.TopologyConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" - in: "body" name: "tapi.path.computation.TopologyConstraint.body-param" - description: "tapi.path.computation.TopologyConstraint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.TopologyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.TopologyConstraint.body-param" - description: "tapi.path.computation.TopologyConstraint to be added or updated" + description: "tapi.path.computation.TopologyConstraint to be added or updated" required: false schema: $ref: "#/definitions/tapi.path.computation.TopologyConstraint" @@ -13891,227 +14843,157 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.path.computation.TopologyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/avoid-topology={topology-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of avoid-topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/exclude-link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LinkRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of exclude-link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of exclude-link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/exclude-node={topology-uuid},{node-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.NodeRef" + summary: "removes tapi.path.computation.TopologyConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of exclude-node" - required: true - type: "string" - - name: "node-uuid" + - name: "local-id" in: "path" - description: "Id of exclude-node" + description: "Id of topology-constraint" required: true type: "string" responses: - 200: - description: "tapi.topology.NodeRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRef" 400: description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/exclude-path={path-uuid}/: - get: + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint={local-id}/name/: + post: tags: - "tapi-path-computation" - description: "returns tapi.path.computation.PathRef" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "path-uuid" + - name: "local-id" in: "path" - description: "Id of exclude-path" + description: "Id of topology-constraint" required: true type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-link={topology-uuid},{link-uuid}/: + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint={local-id}/name={value-name}/: get: tags: - "tapi-path-computation" - description: "returns tapi.topology.LinkRef" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "topology-uuid" + - name: "local-id" in: "path" - description: "Id of include-link" + description: "Id of topology-constraint" required: true type: "string" - - name: "link-uuid" + - name: "value-name" in: "path" - description: "Id of include-link" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.topology.LinkRef" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.topology.LinkRef" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-node={topology-uuid},{node-uuid}/: - get: + put: tags: - "tapi-path-computation" - description: "returns tapi.topology.NodeRef" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "topology-uuid" + - name: "local-id" in: "path" - description: "Id of include-node" + description: "Id of topology-constraint" required: true type: "string" - - name: "node-uuid" + - name: "value-name" in: "path" - description: "Id of include-node" + description: "Id of name" required: true type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" responses: - 200: - description: "tapi.topology.NodeRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRef" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-path={path-uuid}/: - get: + 204: + description: "Object modified" + delete: tags: - "tapi-path-computation" - description: "returns tapi.path.computation.PathRef" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "path-uuid" - in: "path" - description: "Id of include-path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-topology={topology-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" + - name: "local-id" in: "path" - description: "Id of path-comp-service" + description: "Id of topology-constraint" required: true type: "string" - - name: "topology-uuid" + - name: "value-name" in: "path" - description: "Id of include-topology" + description: "Id of name" required: true type: "string" responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" 400: description: "Internal error" + 204: + description: "Object deleted" /data/context/path-computation-context/path={uuid}/: get: tags: - "tapi-path-computation" - description: "returns tapi.path.computation.Path" + summary: "returns tapi.path.computation.Path" + description: "none" parameters: - name: "uuid" in: "path" @@ -14129,7 +15011,8 @@ paths: get: tags: - "tapi-path-computation" - description: "returns tapi.topology.LinkRef" + summary: "returns tapi.topology.LinkRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -14157,7 +15040,10 @@ paths: get: tags: - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -14180,7 +15066,8 @@ paths: get: tags: - "tapi-path-computation" - description: "returns tapi.path.computation.RoutingConstraint" + summary: "returns tapi.path.computation.RoutingConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -14198,7 +15085,9 @@ paths: get: tags: - "tapi-path-computation" - description: "returns tapi.topology.CostCharacteristic" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" @@ -14221,7 +15110,9 @@ paths: get: tags: - "tapi-path-computation" - description: "returns tapi.topology.LatencyCharacteristic" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" @@ -14244,7 +15135,8 @@ paths: get: tags: - "tapi-path-computation" - description: "returns tapi.topology.RiskCharacteristic" + summary: "returns tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" @@ -14267,14 +15159,15 @@ paths: post: tags: - "tapi-common" - description: "creates tapi.common.ServiceInterfacePoint" + summary: "creates tapi.common.context.ServiceInterfacePoint" + description: "none" parameters: - in: "body" - name: "tapi.common.ServiceInterfacePoint.body-param" - description: "tapi.common.ServiceInterfacePoint to be added to list" + name: "tapi.common.context.ServiceInterfacePoint.body-param" + description: "tapi.common.context.ServiceInterfacePoint to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + $ref: "#/definitions/tapi.common.context.ServiceInterfacePoint" responses: 201: description: "Object created" @@ -14286,7 +15179,8 @@ paths: get: tags: - "tapi-common" - description: "returns tapi.common.ServiceInterfacePoint" + summary: "returns tapi.common.context.ServiceInterfacePoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -14295,38 +15189,16 @@ paths: type: "string" responses: 200: - description: "tapi.common.ServiceInterfacePoint" + description: "tapi.common.context.ServiceInterfacePoint" schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.ServiceInterfacePoint.body-param" - description: "tapi.common.ServiceInterfacePoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - responses: - 201: - description: "Object created" + $ref: "#/definitions/tapi.common.context.ServiceInterfacePoint" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-common" - description: "creates or updates tapi.common.ServiceInterfacePoint" + summary: "creates or updates tapi.common.context.ServiceInterfacePoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -14334,11 +15206,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.ServiceInterfacePoint.body-param" - description: "tapi.common.ServiceInterfacePoint to be added or updated" + name: "tapi.common.context.ServiceInterfacePoint.body-param" + description: "tapi.common.context.ServiceInterfacePoint to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + $ref: "#/definitions/tapi.common.context.ServiceInterfacePoint" responses: 201: description: "Object created" @@ -14349,7 +15221,8 @@ paths: delete: tags: - "tapi-common" - description: "removes tapi.common.ServiceInterfacePoint" + summary: "removes tapi.common.context.ServiceInterfacePoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -14365,7 +15238,8 @@ paths: get: tags: - "tapi-common" - description: "returns tapi.common.Capacity" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" @@ -14379,11 +15253,13 @@ paths: $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/: + /data/context/service-interface-point={uuid}/available-capacity/total-size/: get: tags: - "tapi-common" - description: "returns tapi.common.BandwidthProfile" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -14392,16 +15268,17 @@ paths: type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/committed-burst-size/: + /data/context/service-interface-point={uuid}/eth-service-inteface-point-spec/: get: tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" + - "tapi-eth" + summary: "returns tapi.eth.EthServiceIntefacePointSpec" + description: "none" parameters: - name: "uuid" in: "path" @@ -14410,52 +15287,64 @@ paths: type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.eth.EthServiceIntefacePointSpec" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.eth.EthServiceIntefacePointSpec" 400: description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/committed-information-rate/: - get: + post: tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" + - "tapi-eth" + summary: "creates tapi.eth.EthServiceIntefacePointSpec" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of service-interface-point" required: true type: "string" + - in: "body" + name: "tapi.eth.EthServiceIntefacePointSpec.body-param" + description: "tapi.eth.EthServiceIntefacePointSpec to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthServiceIntefacePointSpec" responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/peak-burst-size/: - get: + 409: + description: "Object already exists" + put: tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" + - "tapi-eth" + summary: "creates or updates tapi.eth.EthServiceIntefacePointSpec" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of service-interface-point" required: true type: "string" + - in: "body" + name: "tapi.eth.EthServiceIntefacePointSpec.body-param" + description: "tapi.eth.EthServiceIntefacePointSpec to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthServiceIntefacePointSpec" responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/peak-information-rate/: - get: + 204: + description: "Object modified" + delete: tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" + - "tapi-eth" + summary: "removes tapi.eth.EthServiceIntefacePointSpec" + description: "none" parameters: - name: "uuid" in: "path" @@ -14463,47 +15352,30 @@ paths: required: true type: "string" responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/total-size/: - get: + 204: + description: "Object deleted" + /data/context/service-interface-point={uuid}/name/: + post: tags: - "tapi-common" - description: "returns tapi.common.CapacityValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of service-interface-point" required: true type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/name/: - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -14515,7 +15387,10 @@ paths: get: tags: - "tapi-common" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -14534,38 +15409,13 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-common" - description: "creates or updates tapi.common.NameAndValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -14593,7 +15443,10 @@ paths: delete: tags: - "tapi-common" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -14614,7 +15467,9 @@ paths: get: tags: - "tapi-common" - description: "returns tapi.common.Capacity" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" @@ -14628,101 +15483,13 @@ paths: $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" /data/context/service-interface-point={uuid}/total-potential-capacity/total-size/: get: tags: - "tapi-common" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -14740,7 +15507,8 @@ paths: get: tags: - "tapi-topology" - description: "returns tapi.topology.TopologyContext" + summary: "returns tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" parameters: [] responses: 200: @@ -14752,7 +15520,8 @@ paths: post: tags: - "tapi-topology" - description: "creates tapi.topology.TopologyContext" + summary: "creates tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" parameters: - in: "body" name: "tapi.topology.context.TopologyContext.body-param" @@ -14770,7 +15539,8 @@ paths: put: tags: - "tapi-topology" - description: "creates or updates tapi.topology.TopologyContext" + summary: "creates or updates tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" parameters: - in: "body" name: "tapi.topology.context.TopologyContext.body-param" @@ -14788,7 +15558,8 @@ paths: delete: tags: - "tapi-topology" - description: "removes tapi.topology.TopologyContext" + summary: "removes tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" parameters: [] responses: 400: @@ -14799,7 +15570,8 @@ paths: get: tags: - "tapi-topology" - description: "returns tapi.topology.NetworkTopologyService" + summary: "returns tapi.topology.NetworkTopologyService" + description: "none" parameters: [] responses: 200: @@ -14812,7 +15584,10 @@ paths: get: tags: - "tapi-topology" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "value-name" in: "path" @@ -14830,7 +15605,8 @@ paths: get: tags: - "tapi-topology" - description: "returns tapi.topology.TopologyRef" + summary: "returns tapi.topology.TopologyRef" + description: "none" parameters: - name: "topology-uuid" in: "path" @@ -14848,7 +15624,8 @@ paths: get: tags: - "tapi-topology" - description: "returns tapi.topology.Topology" + summary: "returns tapi.topology.topologycontext.Topology" + description: "none" parameters: - name: "uuid" in: "path" @@ -14862,126 +15639,46 @@ paths: $ref: "#/definitions/tapi.topology.Topology" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Link" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Link" - schema: - $ref: "#/definitions/tapi.topology.Link" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/committed-burst-size/: + /data/context/topology-context/topology={uuid}/boundary-node-edge-point={topology-uuid},{node-uuid},{node-edge-point-uuid}/: get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "link-uuid" + - name: "topology-uuid" in: "path" - description: "Id of link" + description: "Id of boundary-node-edge-point" required: true type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" + - name: "node-uuid" in: "path" - description: "Id of topology" + description: "Id of boundary-node-edge-point" required: true type: "string" - - name: "link-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of link" + description: "Id of boundary-node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.NodeEdgePointRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/peak-burst-size/: + /data/context/topology-context/topology={uuid}/link={link-uuid}/: get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.Link" + description: "none" parameters: - name: "uuid" in: "path" @@ -14995,16 +15692,17 @@ paths: type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.Link" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.Link" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/peak-information-rate/: + /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/: get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" @@ -15018,16 +15716,18 @@ paths: type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/total-size/: get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -15050,7 +15750,9 @@ paths: get: tags: - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" @@ -15078,7 +15780,9 @@ paths: get: tags: - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" @@ -15106,7 +15810,10 @@ paths: get: tags: - "tapi-topology" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -15134,7 +15841,8 @@ paths: : get: tags: - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -15168,34 +15876,13 @@ paths: $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/resilience-type/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.ResilienceType" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.ResilienceType" - schema: - $ref: "#/definitions/tapi.topology.ResilienceType" - 400: - description: "Internal error" /data/context/topology-context/topology={uuid}/link={link-uuid}/risk-characteristic={risk-characteristic-name}/: get: tags: - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." parameters: - name: "uuid" in: "path" @@ -15223,7 +15910,9 @@ paths: get: tags: - "tapi-topology" - description: "returns tapi.common.Capacity" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" @@ -15242,11 +15931,13 @@ paths: $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/: + /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/total-size/: get: tags: - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -15260,131 +15951,18 @@ paths: type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: + /data/context/topology-context/topology={uuid}/link={link-uuid}/validation-mechanism={validation-mechanism}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/validation-mechanism={validation-mechanism}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.ValidationMechanism" + summary: "returns tapi.topology.ValidationMechanism" + description: "Provides details of the specific validation mechanism(s) used\ + \ to confirm the presence of an intended topologicalEntity." parameters: - name: "uuid" in: "path" @@ -15412,7 +15990,10 @@ paths: get: tags: - "tapi-topology" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -15435,7 +16016,8 @@ paths: get: tags: - "tapi-topology" - description: "returns tapi.topology.topology.Node" + summary: "returns tapi.topology.topology.Node" + description: "none" parameters: - name: "uuid" in: "path" @@ -15458,7 +16040,8 @@ paths: : get: tags: - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -15496,7 +16079,8 @@ paths: get: tags: - "tapi-topology" - description: "returns tapi.common.Capacity" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" @@ -15515,11 +16099,13 @@ paths: $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/: + /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/total-size/: get: tags: - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -15533,16 +16119,18 @@ paths: type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/committed-burst-size/: + /data/context/topology-context/topology={uuid}/node={node-uuid}/cost-characteristic={cost-name}/: get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" @@ -15554,18 +16142,24 @@ paths: description: "Id of node" required: true type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.CostCharacteristic" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.CostCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/encap-topology/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.TopologyRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -15579,16 +16173,18 @@ paths: type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.TopologyRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.TopologyRef" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/peak-burst-size/: + /data/context/topology-context/topology={uuid}/node={node-uuid}/latency-characteristic={traffic-property-name}/: get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" @@ -15600,18 +16196,26 @@ paths: description: "Id of node" required: true type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.LatencyCharacteristic" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/peak-information-rate/: + /data/context/topology-context/topology={uuid}/node={node-uuid}/name={value-name}/: get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -15623,18 +16227,24 @@ paths: description: "Id of node" required: true type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/total-size/: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/: get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.node.NodeEdgePoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -15646,18 +16256,24 @@ paths: description: "Id of node" required: true type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.node.NodeEdgePoint" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.node.NodeEdgePoint" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/cost-characteristic={cost-name}/: - get: + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{aggregated-node-edge-point-node-edge-point-uuid}/ + : get: tags: - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -15669,46 +16285,39 @@ paths: description: "Id of node" required: true type: "string" - - name: "cost-name" + - name: "node-edge-point-uuid" in: "path" - description: "Id of cost-characteristic" + description: "Id of node-edge-point" required: true type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/encap-topology/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" + - name: "topology-uuid" in: "path" - description: "Id of topology" + description: "Id of aggregated-node-edge-point" required: true type: "string" - - name: "node-uuid" + - name: "aggregated-node-edge-point-node-uuid" in: "path" - description: "Id of node" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "aggregated-node-edge-point-node-edge-point-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" required: true type: "string" responses: 200: - description: "tapi.topology.TopologyRef" + description: "tapi.topology.NodeEdgePointRef" schema: - $ref: "#/definitions/tapi.topology.TopologyRef" + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/latency-characteristic={traffic-property-name}/: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-capacity/: get: tags: - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" @@ -15720,23 +16329,25 @@ paths: description: "Id of node" required: true type: "string" - - name: "traffic-property-name" + - name: "node-edge-point-uuid" in: "path" - description: "Id of latency-characteristic" + description: "Id of node-edge-point" required: true type: "string" responses: 200: - description: "tapi.topology.LatencyCharacteristic" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/name={value-name}/: - get: + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-capacity/total-size/ + : get: tags: - "tapi-topology" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -15748,23 +16359,24 @@ paths: description: "Id of node" required: true type: "string" - - name: "value-name" + - name: "node-edge-point-uuid" in: "path" - description: "Id of name" + description: "Id of node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/: - get: + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-cep-layer-protocol={layer-protocol-qualifier}/ + : get: tags: - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroup" + summary: "returns tapi.topology.NepLayerProtocolCapability" + description: "none" parameters: - name: "uuid" in: "path" @@ -15776,23 +16388,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "layer-protocol-qualifier" + in: "path" + description: "Id of available-cep-layer-protocol" required: true type: "string" responses: 200: - description: "tapi.topology.NodeRuleGroup" + description: "tapi.topology.NepLayerProtocolCapability" schema: - $ref: "#/definitions/tapi.topology.NodeRuleGroup" + $ref: "#/definitions/tapi.topology.NepLayerProtocolCapability" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/: get: tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" + - "tapi-connectivity" + summary: "returns tapi.connectivity.context.topologycontext.topology.node.nodeedgepoint.CepList" + description: "none" parameters: - name: "uuid" in: "path" @@ -15804,23 +16422,24 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.Capacity" + description: "tapi.connectivity.context.topologycontext.topology.node.nodeedgepoint.CepList" schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.connectivity.context.topologycontext.topology.node.nodeedgepoint.CepList" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" + - "tapi-connectivity" + summary: "returns tapi.connectivity.ceplist.ConnectionEndPoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -15832,23 +16451,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.connectivity.ceplist.ConnectionEndPoint" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.connectivity.ceplist.ConnectionEndPoint" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/aggregated-connection-end-point={topology-uuid},{aggregated-connection-end-point-node-uuid},{aggregated-connection-end-point-node-edge-point-uuid},{aggregated-connection-end-point-connection-end-point-uuid}/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" + - "tapi-connectivity" + summary: "returns tapi.connectivity.ConnectionEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -15860,51 +16485,49 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" + - name: "connection-end-point-uuid" in: "path" - description: "Id of topology" + description: "Id of connection-end-point" required: true type: "string" - - name: "node-uuid" + - name: "topology-uuid" in: "path" - description: "Id of node" + description: "Id of aggregated-connection-end-point" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "aggregated-connection-end-point-node-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of aggregated-connection-end-point" + required: true + type: "string" + - name: "aggregated-connection-end-point-node-edge-point-uuid" + in: "path" + description: "Id of aggregated-connection-end-point" + required: true + type: "string" + - name: "aggregated-connection-end-point-connection-end-point-uuid" + in: "path" + description: "Id of aggregated-connection-end-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.connectivity.ConnectionEndPointRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.connectivity.ConnectionEndPointRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/client-node-edge-point={topology-uuid},{client-node-edge-point-node-uuid},{client-node-edge-point-node-edge-point-uuid}/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" + - "tapi-connectivity" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -15916,51 +16539,45 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" + - name: "connection-end-point-uuid" in: "path" - description: "Id of topology" + description: "Id of connection-end-point" required: true type: "string" - - name: "node-uuid" + - name: "topology-uuid" in: "path" - description: "Id of node" + description: "Id of client-node-edge-point" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "client-node-edge-point-node-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of client-node-edge-point" + required: true + type: "string" + - name: "client-node-edge-point-node-edge-point-uuid" + in: "path" + description: "Id of client-node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.NodeEdgePointRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/total-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" + - "tapi-eth" + summary: "returns tapi.eth.EthConnectionEndPointSpec" + description: "Augments the base LayerProtocol information in ConnectionEndPoint\ + \ with ETH-specific information" parameters: - name: "uuid" in: "path" @@ -15972,23 +16589,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.eth.EthConnectionEndPointSpec" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.eth.EthConnectionEndPointSpec" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/composed-rule-group={topology-uuid},{composed-rule-group-node-uuid},{composed-rule-group-node-rule-group-uuid}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/eth-ctp/ : get: tags: - - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroupRef" + - "tapi-eth" + summary: "returns tapi.eth.EthCtpPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -16000,38 +16623,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of composed-rule-group" - required: true - type: "string" - - name: "composed-rule-group-node-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of composed-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "composed-rule-group-node-rule-group-uuid" + - name: "connection-end-point-uuid" in: "path" - description: "Id of composed-rule-group" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.topology.NodeRuleGroupRef" + description: "tapi.eth.EthCtpPac" schema: - $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + $ref: "#/definitions/tapi.eth.EthCtpPac" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/cost-characteristic={cost-name}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/eth-ctp/eth-ctp-common-pac/ : get: tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" + - "tapi-eth" + summary: "returns tapi.eth.EthCtpCommonPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -16043,28 +16657,38 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "cost-name" + - name: "connection-end-point-uuid" in: "path" - description: "Id of cost-characteristic" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.topology.CostCharacteristic" + description: "tapi.eth.EthCtpCommonPac" schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" + $ref: "#/definitions/tapi.eth.EthCtpCommonPac" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/eth-ctp/eth-ctp-common-pac/filter-config/ : get: tags: - - "tapi-topology" - description: "returns tapi.topology.InterRuleGroup" + - "tapi-eth" + summary: "returns tapi.eth.ControlFrameFilter" + description: "This attribute models the FilterConfig MI defined in section 8.3/G.8021.\ + \ It indicates the configured filter action for each of the 33 group MAC addresses\ + \ for control frames. The 33 MAC addresses are:\r\n - All bridges\ + \ address: 01-80-C2-00-00-10,\r\n - Reserved addresses: 01-80-C2-00-00-00\ + \ to 01-80-C2-00-00-0F,\r\n - GARP Application addresses: 01-80-C2-00-00-20\ + \ to 01-80-C2-00-00-2F.\r\n The filter action is Pass or Block.\ + \ \r\n If the destination address of the incoming ETH_CI_D\ + \ matches one of the above addresses, the filter process shall perform the\ + \ corresponding configured filter action. \r\n If none of the\ + \ above addresses match, the ETH_CI_D is passed." parameters: - name: "uuid" in: "path" @@ -16076,28 +16700,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "connection-end-point-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.topology.InterRuleGroup" + description: "tapi.eth.ControlFrameFilter" schema: - $ref: "#/definitions/tapi.topology.InterRuleGroup" + $ref: "#/definitions/tapi.eth.ControlFrameFilter" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/associated-node-rule-group={topology-uuid},{associated-node-rule-group-node-uuid},{associated-node-rule-group-node-rule-group-uuid}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/eth-ctp/eth-ctp-common-pac/traffic-conditioning-pac/ : get: tags: - - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroupRef" + - "tapi-eth" + summary: "returns tapi.eth.TrafficConditioningPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -16109,43 +16734,36 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of associated-node-rule-group" - required: true - type: "string" - - name: "associated-node-rule-group-node-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of associated-node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "associated-node-rule-group-node-rule-group-uuid" + - name: "connection-end-point-uuid" in: "path" - description: "Id of associated-node-rule-group" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.topology.NodeRuleGroupRef" + description: "tapi.eth.TrafficConditioningPac" schema: - $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + $ref: "#/definitions/tapi.eth.TrafficConditioningPac" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/eth-ctp/eth-ctp-common-pac/traffic-conditioning-pac/cond-config-list={queue-id}/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" + - "tapi-eth" + summary: "returns tapi.eth.TrafficConditioningConfiguration" + description: "This attribute indicates for the conditioner process the conditioning\ + \ parameters:\r\n - Queue ID: Indicates the Queue ID\r\n \ + \ - Committed Information Rate (CIR): number of bits per second\r\ + \n - Committed Burst Size (CBS): number of bytes\r\n \ + \ - Excess Information Rate (EIR): number of bits per second\r\n\ + \ - Excess Burst Size (EBS): number of bytes\r\n \ + \ - Coupling flag (CF): 0 or 1\r\n - Color mode (CM):\ + \ color-blind and color-aware." parameters: - name: "uuid" in: "path" @@ -16157,28 +16775,36 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "connection-end-point-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of connection-end-point" required: true type: "string" + - name: "queue-id" + in: "path" + description: "Id of cond-config-list" + required: true + type: "integer" + format: "int32" responses: 200: - description: "tapi.common.Capacity" + description: "tapi.eth.TrafficConditioningConfiguration" schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.eth.TrafficConditioningConfiguration" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/eth-ctp/eth-ctp-common-pac/traffic-conditioning-pac/prio-config-list={queue-id}/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" + - "tapi-eth" + summary: "returns tapi.eth.PriorityConfiguration" + description: "This attribute indicates the Priority Splitter function for the\ + \ mapping of the Ethernet frame priority (ETH_CI_P) values to the output queue." parameters: - name: "uuid" in: "path" @@ -16190,28 +16816,35 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "connection-end-point-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of connection-end-point" required: true type: "string" + - name: "queue-id" + in: "path" + description: "Id of prio-config-list" + required: true + type: "integer" + format: "int32" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.eth.PriorityConfiguration" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.eth.PriorityConfiguration" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/eth-ctp/eth-ctp-common-pac/traffic-shaping-pac/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" + - "tapi-eth" + summary: "returns tapi.eth.TrafficShapingPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -16223,28 +16856,30 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "connection-end-point-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.eth.TrafficShapingPac" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.eth.TrafficShapingPac" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/eth-ctp/eth-ctp-common-pac/traffic-shaping-pac/prio-config-list={queue-id}/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" + - "tapi-eth" + summary: "returns tapi.eth.PriorityConfiguration" + description: "This attribute configures the Priority Splitter function for the\ + \ mapping of the Ethernet frame priority (ETH_CI_P) values to the output queue." parameters: - name: "uuid" in: "path" @@ -16256,28 +16891,41 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "connection-end-point-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of connection-end-point" required: true type: "string" + - name: "queue-id" + in: "path" + description: "Id of prio-config-list" + required: true + type: "integer" + format: "int32" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.eth.PriorityConfiguration" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.eth.PriorityConfiguration" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/eth-ctp/eth-ctp-common-pac/traffic-shaping-pac/queue-config-list={queue-id}/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" + - "tapi-eth" + summary: "returns tapi.eth.QueueConfiguration" + description: "This attribute configures the Queue depth and Dropping threshold\ + \ parameters of the Queue process. The Queue depth sets the maximum size of\ + \ the queue in bytes. An incoming ETH_CI traffic unit is dropped if there\ + \ is insufficient space in the queue to hold the whole unit. The Dropping\ + \ threshold sets the threshold of the queue. If the queue is filled beyond\ + \ this threshold, incoming ETH_CI traffic units accompanied by the ETH_CI_DE\ + \ signal set are dropped." parameters: - name: "uuid" in: "path" @@ -16289,28 +16937,35 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "connection-end-point-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of connection-end-point" required: true type: "string" + - name: "queue-id" + in: "path" + description: "Id of queue-config-list" + required: true + type: "integer" + format: "int32" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.eth.QueueConfiguration" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.eth.QueueConfiguration" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/eth-term/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" + - "tapi-eth" + summary: "returns tapi.eth.EthTerminationPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -16322,28 +16977,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "connection-end-point-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.eth.EthTerminationPac" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.eth.EthTerminationPac" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/total-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/eth-term/eth-termination-common-pac/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" + - "tapi-eth" + summary: "returns tapi.eth.EthTerminationCommonPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -16355,28 +17011,30 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "connection-end-point-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.eth.EthTerminationCommonPac" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.eth.EthTerminationCommonPac" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/cost-characteristic={cost-name}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/eth-term/eth-termination-common-pac/priority-regenerate/ : get: tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" + - "tapi-eth" + summary: "returns tapi.eth.PriorityMapping" + description: "This attribute models the ETHx/ETH-m _A_Sk_MI_P_Regenerate information\ + \ defined in G.8021." parameters: - name: "uuid" in: "path" @@ -16388,33 +17046,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "cost-name" + - name: "connection-end-point-uuid" in: "path" - description: "Id of cost-characteristic" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.topology.CostCharacteristic" + description: "tapi.eth.PriorityMapping" schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" + $ref: "#/definitions/tapi.eth.PriorityMapping" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/latency-characteristic={traffic-property-name}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/ety-term/ : get: tags: - - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" + - "tapi-eth" + summary: "returns tapi.eth.EtyTerminationPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -16426,33 +17080,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "traffic-property-name" + - name: "connection-end-point-uuid" in: "path" - description: "Id of latency-characteristic" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.topology.LatencyCharacteristic" + description: "tapi.eth.EtyTerminationPac" schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + $ref: "#/definitions/tapi.eth.EtyTerminationPac" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/name={value-name}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/ety-term/ety-termination-common-pac/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" + - "tapi-eth" + summary: "returns tapi.eth.EtyTerminationCommonPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -16464,33 +17114,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "value-name" + - name: "connection-end-point-uuid" in: "path" - description: "Id of name" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.eth.EtyTerminationCommonPac" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.eth.EtyTerminationCommonPac" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/ : get: tags: - - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" + - "tapi-oam" + summary: "returns tapi.oam.MepMipList" + description: "none" parameters: - name: "uuid" in: "path" @@ -16502,33 +17148,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "risk-characteristic-name" + - name: "connection-end-point-uuid" in: "path" - description: "Id of risk-characteristic" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.topology.RiskCharacteristic" + description: "tapi.oam.MepMipList" schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" + $ref: "#/definitions/tapi.oam.MepMipList" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/mep={meg-uuid},{mep-local-id}/ : get: tags: - - "tapi-topology" - description: "returns tapi.topology.Rule" + - "tapi-oam" + summary: "returns tapi.oam.MepRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -16540,33 +17182,39 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "connection-end-point-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of connection-end-point" required: true type: "string" - - name: "local-id" + - name: "meg-uuid" in: "path" - description: "Id of rule" + description: "Id of mep" + required: true + type: "string" + - name: "mep-local-id" + in: "path" + description: "Id of mep" required: true type: "string" responses: 200: - description: "tapi.topology.Rule" + description: "tapi.oam.MepRef" schema: - $ref: "#/definitions/tapi.topology.Rule" + $ref: "#/definitions/tapi.oam.MepRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/name={value-name}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/mip={meg-uuid},{mip-local-id}/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" + - "tapi-oam" + summary: "returns tapi.oam.MipRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -16578,38 +17226,41 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "connection-end-point-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of connection-end-point" required: true type: "string" - - name: "local-id" + - name: "meg-uuid" in: "path" - description: "Id of rule" + description: "Id of mip" required: true type: "string" - - name: "value-name" + - name: "mip-local-id" in: "path" - description: "Id of name" + description: "Id of mip" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.oam.MipRef" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.oam.MipRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/name={value-name}/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" + - "tapi-connectivity" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -16621,28 +17272,34 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "connection-end-point-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.common.Capacity" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/parent-node-edge-point/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" + - "tapi-connectivity" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -16654,28 +17311,31 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "connection-end-point-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.topology.NodeEdgePointRef" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/mapped-service-interface-point={service-interface-point-uuid}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "NodeEdgePoint mapped to more than ServiceInterfacePoint (slicing/virtualizing)\ + \ or a ServiceInterfacePoint mapped to more than one NodeEdgePoint (load balancing/Resilience)\ + \ should be considered experimental" parameters: - name: "uuid" in: "path" @@ -16687,28 +17347,31 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "service-interface-point-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of mapped-service-interface-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.ServiceInterfacePointRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/name={value-name}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -16720,28 +17383,30 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "value-name" in: "path" - description: "Id of inter-rule-group" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/total-potential-capacity/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" @@ -16753,28 +17418,25 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/total-potential-capacity/total-size/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -16786,14 +17448,9 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of node-edge-point" required: true type: "string" responses: @@ -16803,11 +17460,12 @@ paths: $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/total-size/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.NodeRuleGroup" + description: "none" parameters: - name: "uuid" in: "path" @@ -16824,23 +17482,19 @@ paths: description: "Id of node-rule-group" required: true type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.NodeRuleGroup" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.NodeRuleGroup" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/latency-characteristic={traffic-property-name}/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/: + get: tags: - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" @@ -16857,23 +17511,20 @@ paths: description: "Id of node-rule-group" required: true type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" responses: 200: - description: "tapi.topology.LatencyCharacteristic" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/name={value-name}/: - get: + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/total-size/ + : get: tags: - "tapi-topology" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -16890,23 +17541,19 @@ paths: description: "Id of node-rule-group" required: true type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/node-edge-point={topology-uuid},{node-edge-point-node-uuid},{node-edge-point-uuid}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/composed-rule-group={topology-uuid},{composed-rule-group-node-uuid},{composed-rule-group-node-rule-group-uuid}/ : get: tags: - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" + summary: "returns tapi.topology.NodeRuleGroupRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -16925,31 +17572,33 @@ paths: type: "string" - name: "topology-uuid" in: "path" - description: "Id of node-edge-point" + description: "Id of composed-rule-group" required: true type: "string" - - name: "node-edge-point-node-uuid" + - name: "composed-rule-group-node-uuid" in: "path" - description: "Id of node-edge-point" + description: "Id of composed-rule-group" required: true type: "string" - - name: "node-edge-point-uuid" + - name: "composed-rule-group-node-rule-group-uuid" in: "path" - description: "Id of node-edge-point" + description: "Id of composed-rule-group" required: true type: "string" responses: 200: - description: "tapi.topology.NodeEdgePointRef" + description: "tapi.topology.NodeRuleGroupRef" schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/cost-characteristic={cost-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" @@ -16966,23 +17615,24 @@ paths: description: "Id of node-rule-group" required: true type: "string" - - name: "risk-characteristic-name" + - name: "cost-name" in: "path" - description: "Id of risk-characteristic" + description: "Id of cost-characteristic" required: true type: "string" responses: 200: - description: "tapi.topology.RiskCharacteristic" + description: "tapi.topology.CostCharacteristic" schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" + $ref: "#/definitions/tapi.topology.CostCharacteristic" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/: - get: + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/ + : get: tags: - "tapi-topology" - description: "returns tapi.topology.Rule" + summary: "returns tapi.topology.InterRuleGroup" + description: "none" parameters: - name: "uuid" in: "path" @@ -16999,23 +17649,24 @@ paths: description: "Id of node-rule-group" required: true type: "string" - - name: "local-id" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of rule" + description: "Id of inter-rule-group" required: true type: "string" responses: 200: - description: "tapi.topology.Rule" + description: "tapi.topology.InterRuleGroup" schema: - $ref: "#/definitions/tapi.topology.Rule" + $ref: "#/definitions/tapi.topology.InterRuleGroup" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/name={value-name}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/associated-node-rule-group={topology-uuid},{associated-node-rule-group-node-uuid},{associated-node-rule-group-node-rule-group-uuid}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.topology.NodeRuleGroupRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -17032,28 +17683,39 @@ paths: description: "Id of node-rule-group" required: true type: "string" - - name: "local-id" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of rule" + description: "Id of inter-rule-group" required: true type: "string" - - name: "value-name" + - name: "topology-uuid" in: "path" - description: "Id of name" + description: "Id of associated-node-rule-group" + required: true + type: "string" + - name: "associated-node-rule-group-node-uuid" + in: "path" + description: "Id of associated-node-rule-group" + required: true + type: "string" + - name: "associated-node-rule-group-node-rule-group-uuid" + in: "path" + description: "Id of associated-node-rule-group" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.topology.NodeRuleGroupRef" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/ : get: tags: - "tapi-topology" - description: "returns tapi.common.Capacity" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" @@ -17070,6 +17732,11 @@ paths: description: "Id of node-rule-group" required: true type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" responses: 200: description: "tapi.common.Capacity" @@ -17077,11 +17744,13 @@ paths: $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/total-size/ : get: tags: - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -17098,18 +17767,25 @@ paths: description: "Id of node-rule-group" required: true type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/cost-characteristic={cost-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" @@ -17126,18 +17802,30 @@ paths: description: "Id of node-rule-group" required: true type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.CostCharacteristic" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.CostCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/latency-characteristic={traffic-property-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" @@ -17154,18 +17842,31 @@ paths: description: "Id of node-rule-group" required: true type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.LatencyCharacteristic" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/name={value-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -17182,18 +17883,30 @@ paths: description: "Id of node-rule-group" required: true type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." parameters: - name: "uuid" in: "path" @@ -17210,18 +17923,29 @@ paths: description: "Id of node-rule-group" required: true type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-characteristic" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.RiskCharacteristic" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.RiskCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/total-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.Rule" + description: "none" parameters: - name: "uuid" in: "path" @@ -17238,46 +17962,31 @@ paths: description: "Id of node-rule-group" required: true type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.node.OwnedNodeEdgePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of node" + description: "Id of inter-rule-group" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "local-id" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of rule" required: true type: "string" responses: 200: - description: "tapi.topology.node.OwnedNodeEdgePoint" + description: "tapi.topology.Rule" schema: - $ref: "#/definitions/tapi.topology.node.OwnedNodeEdgePoint" + $ref: "#/definitions/tapi.topology.Rule" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/name={value-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -17289,38 +17998,40 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-rule-group" required: true type: "string" - - name: "topology-uuid" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of aggregated-node-edge-point" + description: "Id of inter-rule-group" required: true type: "string" - - name: "aggregated-node-edge-point-node-uuid" + - name: "local-id" in: "path" - description: "Id of aggregated-node-edge-point" + description: "Id of rule" required: true type: "string" - - name: "node-edge-point-uuid" + - name: "value-name" in: "path" - description: "Id of aggregated-node-edge-point" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.topology.NodeEdgePointRef" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/ : get: tags: - "tapi-topology" - description: "returns tapi.common.Capacity" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" @@ -17332,9 +18043,14 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of inter-rule-group" required: true type: "string" responses: @@ -17344,11 +18060,13 @@ paths: $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/total-size/ : get: tags: - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -17360,23 +18078,30 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of inter-rule-group" required: true type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/latency-characteristic={traffic-property-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" @@ -17388,23 +18113,31 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "traffic-property-name" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of latency-characteristic" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.LatencyCharacteristic" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/name={value-name}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -17416,23 +18149,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "value-name" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/node-edge-point={topology-uuid},{node-edge-point-node-uuid},{node-edge-point-uuid}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -17444,51 +18183,40 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-rule-group" required: true type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" + - name: "topology-uuid" in: "path" - description: "Id of topology" + description: "Id of node-edge-point" required: true type: "string" - - name: "node-uuid" + - name: "node-edge-point-node-uuid" in: "path" - description: "Id of node" + description: "Id of node-edge-point" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.NodeEdgePointRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/total-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." parameters: - name: "uuid" in: "path" @@ -17500,51 +18228,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.context.topologycontext.topology.node.ownednodeedgepoint.CepList" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of node" + description: "Id of node-rule-group" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "risk-characteristic-name" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of risk-characteristic" required: true type: "string" responses: 200: - description: "tapi.connectivity.context.topologycontext.topology.node.ownednodeedgepoint.CepList" + description: "tapi.topology.RiskCharacteristic" schema: - $ref: "#/definitions/tapi.connectivity.context.topologycontext.topology.node.ownednodeedgepoint.CepList" + $ref: "#/definitions/tapi.topology.RiskCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/: + get: tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ceplist.ConnectionEndPoint" + - "tapi-topology" + summary: "returns tapi.topology.Rule" + description: "none" parameters: - name: "uuid" in: "path" @@ -17556,28 +18262,31 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-rule-group" required: true type: "string" - - name: "connection-end-point-uuid" + - name: "local-id" in: "path" - description: "Id of connection-end-point" + description: "Id of rule" required: true type: "string" responses: 200: - description: "tapi.connectivity.ceplist.ConnectionEndPoint" + description: "tapi.topology.Rule" schema: - $ref: "#/definitions/tapi.connectivity.ceplist.ConnectionEndPoint" + $ref: "#/definitions/tapi.topology.Rule" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/aggregated-connection-end-point={topology-uuid},{aggregated-connection-end-point-node-uuid},{node-edge-point-uuid},{aggregated-connection-end-point-connection-end-point-uuid}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/name={value-name}/ : get: tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionEndPointRef" + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -17589,48 +18298,35 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of aggregated-connection-end-point" - required: true - type: "string" - - name: "aggregated-connection-end-point-node-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of aggregated-connection-end-point" + description: "Id of node-rule-group" required: true type: "string" - - name: "node-edge-point-uuid" + - name: "local-id" in: "path" - description: "Id of aggregated-connection-end-point" + description: "Id of rule" required: true type: "string" - - name: "aggregated-connection-end-point-connection-end-point-uuid" + - name: "value-name" in: "path" - description: "Id of aggregated-connection-end-point" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.connectivity.ConnectionEndPointRef" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.connectivity.ConnectionEndPointRef" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/client-node-edge-point={topology-uuid},{client-node-edge-point-node-uuid},{node-edge-point-uuid}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/ : get: tags: - - "tapi-connectivity" - description: "returns tapi.topology.NodeEdgePointRef" + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" @@ -17642,43 +18338,25 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of client-node-edge-point" - required: true - type: "string" - - name: "client-node-edge-point-node-uuid" - in: "path" - description: "Id of client-node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of client-node-edge-point" + description: "Id of node-rule-group" required: true type: "string" responses: 200: - description: "tapi.topology.NodeEdgePointRef" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/total-size/ : get: tags: - - "tapi-eth" - description: "returns tapi.eth.EthConnectionEndPointSpec" + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -17690,28 +18368,25 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of connection-end-point" + description: "Id of node-rule-group" required: true type: "string" responses: 200: - description: "tapi.eth.EthConnectionEndPointSpec" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.eth.EthConnectionEndPointSpec" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/eth-ctp/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/: + get: tags: - - "tapi-eth" - description: "returns tapi.eth.EthCtpPac" + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" @@ -17723,28 +18398,20 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" responses: 200: - description: "tapi.eth.EthCtpPac" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.eth.EthCtpPac" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/eth-ctp/filter-config/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/total-size/: + get: tags: - - "tapi-eth" - description: "returns tapi.eth.ControlFrameFilter" + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -17756,1058 +18423,147 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" responses: 200: - description: "tapi.eth.ControlFrameFilter" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.eth.ControlFrameFilter" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/eth-ctp/traffic-conditioning/ - : get: + /operations/compute-p-2-p-path/: + post: tags: - - "tapi-eth" - description: "returns tapi.eth.TrafficConditioningPac" + - "tapi-path-computation" + summary: "operates on tapi.path.computation.ComputeP2PPath" + description: "operates on tapi.path.computation.ComputeP2PPath" parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" + - in: "body" + name: "tapi.path.computation.computep2ppath.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.path.computation.computep2ppath.Input" responses: 200: - description: "tapi.eth.TrafficConditioningPac" + description: "Correct response" schema: - $ref: "#/definitions/tapi.eth.TrafficConditioningPac" + $ref: "#/definitions/tapi.path.computation.ComputeP2PPath" + 201: + description: "No response" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/eth-ctp/traffic-conditioning/cond-config-list={queue-id}/ - : get: + /operations/create-connectivity-service/: + post: tags: - - "tapi-eth" - description: "returns tapi.eth.TrafficConditioningConfiguration" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "queue-id" - in: "path" - description: "Id of cond-config-list" - required: true - type: "integer" - format: "int32" - responses: - 200: - description: "tapi.eth.TrafficConditioningConfiguration" - schema: - $ref: "#/definitions/tapi.eth.TrafficConditioningConfiguration" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/eth-ctp/traffic-conditioning/prio-config-list={queue-id}/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.PriorityConfiguration" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "queue-id" - in: "path" - description: "Id of prio-config-list" - required: true - type: "integer" - format: "int32" - responses: - 200: - description: "tapi.eth.PriorityConfiguration" - schema: - $ref: "#/definitions/tapi.eth.PriorityConfiguration" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/eth-ctp/traffic-shaping/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.TrafficShapingPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.TrafficShapingPac" - schema: - $ref: "#/definitions/tapi.eth.TrafficShapingPac" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/eth-ctp/traffic-shaping/prio-config-list={queue-id}/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.PriorityConfiguration" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "queue-id" - in: "path" - description: "Id of prio-config-list" - required: true - type: "integer" - format: "int32" - responses: - 200: - description: "tapi.eth.PriorityConfiguration" - schema: - $ref: "#/definitions/tapi.eth.PriorityConfiguration" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/eth-ctp/traffic-shaping/queue-config-list={queue-id}/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.QueueConfiguration" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "queue-id" - in: "path" - description: "Id of queue-config-list" - required: true - type: "integer" - format: "int32" - responses: - 200: - description: "tapi.eth.QueueConfiguration" - schema: - $ref: "#/definitions/tapi.eth.QueueConfiguration" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/eth-term/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EthTerminationPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.EthTerminationPac" - schema: - $ref: "#/definitions/tapi.eth.EthTerminationPac" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/eth-term/priority-regenerate/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.PriorityMapping" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.PriorityMapping" - schema: - $ref: "#/definitions/tapi.eth.PriorityMapping" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/ety-term/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EtyTerminationPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.EtyTerminationPac" - schema: - $ref: "#/definitions/tapi.eth.EtyTerminationPac" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/ - : get: - tags: - - "tapi-oam" - description: "returns tapi.oam.MepMipList" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.MepMipList" - schema: - $ref: "#/definitions/tapi.oam.MepMipList" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/mep={meg-uuid},{mep-local-id}/ - : get: - tags: - - "tapi-oam" - description: "returns tapi.oam.MepRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "meg-uuid" - in: "path" - description: "Id of mep" - required: true - type: "string" - - name: "mep-local-id" - in: "path" - description: "Id of mep" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.MepRef" - schema: - $ref: "#/definitions/tapi.oam.MepRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/mip={meg-uuid},{mip-local-id}/ - : get: - tags: - - "tapi-oam" - description: "returns tapi.oam.MipRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "meg-uuid" - in: "path" - description: "Id of mip" - required: true - type: "string" - - name: "mip-local-id" - in: "path" - description: "Id of mip" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.MipRef" - schema: - $ref: "#/definitions/tapi.oam.MipRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/name={value-name}/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/parent-node-edge-point/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/mapped-service-interface-point={service-interface-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.ServiceInterfacePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "service-interface-point-uuid" - in: "path" - description: "Id of mapped-service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.ServiceInterfacePointRef" - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/name={value-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /operations/compute-p-2-p-path/: - post: - tags: - - "tapi-path-computation" + - "tapi-connectivity" + summary: "operates on tapi.connectivity.CreateConnectivityService" + description: "operates on tapi.connectivity.CreateConnectivityService" parameters: - in: "body" - name: "tapi.path.computation.computep2ppath.Input.body-param" + name: "tapi.connectivity.createconnectivityservice.Input.body-param" required: false schema: properties: input: - $ref: "#/definitions/tapi.path.computation.computep2ppath.Input" + $ref: "#/definitions/tapi.connectivity.createconnectivityservice.Input" responses: 200: description: "Correct response" schema: - $ref: "#/definitions/tapi.path.computation.ComputeP2PPath" + $ref: "#/definitions/tapi.connectivity.CreateConnectivityService" 201: description: "No response" 400: description: "Internal error" - /operations/create-connectivity-service/: + /operations/create-notification-subscription-service/: post: tags: - - "tapi-connectivity" + - "tapi-notification" + summary: "operates on tapi.notification.CreateNotificationSubscriptionService" + description: "operates on tapi.notification.CreateNotificationSubscriptionService" parameters: - in: "body" - name: "tapi.connectivity.createconnectivityservice.Input.body-param" + name: "tapi.notification.createnotificationsubscriptionservice.Input.body-param" required: false schema: properties: input: - $ref: "#/definitions/tapi.connectivity.createconnectivityservice.Input" + $ref: "#/definitions/tapi.notification.createnotificationsubscriptionservice.Input" responses: 200: description: "Correct response" schema: - $ref: "#/definitions/tapi.connectivity.CreateConnectivityService" + $ref: "#/definitions/tapi.notification.CreateNotificationSubscriptionService" 201: description: "No response" 400: description: "Internal error" - /operations/create-notification-subscription-service/: + /operations/create-oam-job/: post: tags: - - "tapi-notification" + - "tapi-oam" + summary: "operates on tapi.oam.CreateOamJob" + description: "operates on tapi.oam.CreateOamJob" parameters: - in: "body" - name: "tapi.notification.createnotificationsubscriptionservice.Input.body-param" + name: "tapi.oam.createoamjob.Input.body-param" required: false schema: properties: input: - $ref: "#/definitions/tapi.notification.createnotificationsubscriptionservice.Input" + $ref: "#/definitions/tapi.oam.createoamjob.Input" responses: 200: description: "Correct response" schema: - $ref: "#/definitions/tapi.notification.CreateNotificationSubscriptionService" + $ref: "#/definitions/tapi.oam.CreateOamJob" 201: description: "No response" 400: description: "Internal error" - /operations/create-oam-job/: + /operations/create-oam-profile/: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.CreateOamProfile" + description: "operates on tapi.oam.CreateOamProfile" parameters: - in: "body" - name: "tapi.oam.createoamjob.Input.body-param" + name: "tapi.oam.createoamprofile.Input.body-param" required: false schema: properties: input: - $ref: "#/definitions/tapi.oam.createoamjob.Input" + $ref: "#/definitions/tapi.oam.createoamprofile.Input" responses: 200: description: "Correct response" schema: - $ref: "#/definitions/tapi.oam.CreateOamJob" + $ref: "#/definitions/tapi.oam.CreateOamProfile" 201: description: "No response" 400: description: "Internal error" - /operations/create-oam-service-end-point/: + /operations/create-oam-service-point/: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.CreateOamServicePoint" + description: "operates on tapi.oam.CreateOamServicePoint" parameters: - in: "body" - name: "tapi.oam.createoamserviceendpoint.Input.body-param" + name: "tapi.oam.createoamservicepoint.Input.body-param" required: false schema: properties: input: - $ref: "#/definitions/tapi.oam.createoamserviceendpoint.Input" + $ref: "#/definitions/tapi.oam.createoamservicepoint.Input" responses: 200: description: "Correct response" schema: - $ref: "#/definitions/tapi.oam.CreateOamServiceEndPoint" + $ref: "#/definitions/tapi.oam.CreateOamServicePoint" 201: description: "No response" 400: @@ -18816,6 +18572,8 @@ paths: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.CreateOamService" + description: "operates on tapi.oam.CreateOamService" parameters: - in: "body" name: "tapi.oam.createoamservice.Input.body-param" @@ -18837,6 +18595,8 @@ paths: post: tags: - "tapi-connectivity" + summary: "operates on tapi.connectivity.DeleteConnectivityService" + description: "operates on tapi.connectivity.DeleteConnectivityService" parameters: - in: "body" name: "tapi.connectivity.deleteconnectivityservice.Input.body-param" @@ -18854,6 +18614,8 @@ paths: post: tags: - "tapi-notification" + summary: "operates on tapi.notification.DeleteNotificationSubscriptionService" + description: "operates on tapi.notification.DeleteNotificationSubscriptionService" parameters: - in: "body" name: "tapi.notification.deletenotificationsubscriptionservice.Input.body-param" @@ -18863,10 +18625,6 @@ paths: input: $ref: "#/definitions/tapi.notification.deletenotificationsubscriptionservice.Input" responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.DeleteNotificationSubscriptionService" 201: description: "No response" 400: @@ -18875,6 +18633,8 @@ paths: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.DeleteOamJob" + description: "operates on tapi.oam.DeleteOamJob" parameters: - in: "body" name: "tapi.oam.deleteoamjob.Input.body-param" @@ -18888,18 +18648,39 @@ paths: description: "No response" 400: description: "Internal error" - /operations/delete-oam-service-end-point/: + /operations/delete-oam-profile/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.DeleteOamProfile" + description: "operates on tapi.oam.DeleteOamProfile" + parameters: + - in: "body" + name: "tapi.oam.deleteoamprofile.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.deleteoamprofile.Input" + responses: + 201: + description: "No response" + 400: + description: "Internal error" + /operations/delete-oam-service-point/: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.DeleteOamServicePoint" + description: "operates on tapi.oam.DeleteOamServicePoint" parameters: - in: "body" - name: "tapi.oam.deleteoamserviceendpoint.Input.body-param" + name: "tapi.oam.deleteoamservicepoint.Input.body-param" required: false schema: properties: input: - $ref: "#/definitions/tapi.oam.deleteoamserviceendpoint.Input" + $ref: "#/definitions/tapi.oam.deleteoamservicepoint.Input" responses: 201: description: "No response" @@ -18909,6 +18690,8 @@ paths: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.DeleteOamService" + description: "operates on tapi.oam.DeleteOamService" parameters: - in: "body" name: "tapi.oam.deleteoamservice.Input.body-param" @@ -18926,6 +18709,8 @@ paths: post: tags: - "tapi-path-computation" + summary: "operates on tapi.path.computation.DeleteP2PPath" + description: "operates on tapi.path.computation.DeleteP2PPath" parameters: - in: "body" name: "tapi.path.computation.deletep2ppath.Input.body-param" @@ -18947,6 +18732,8 @@ paths: post: tags: - "tapi-connectivity" + summary: "operates on tapi.connectivity.GetConnectionDetails" + description: "operates on tapi.connectivity.GetConnectionDetails" parameters: - in: "body" name: "tapi.connectivity.getconnectiondetails.Input.body-param" @@ -18968,6 +18755,8 @@ paths: post: tags: - "tapi-connectivity" + summary: "operates on tapi.connectivity.GetConnectionEndPointDetails" + description: "operates on tapi.connectivity.GetConnectionEndPointDetails" parameters: - in: "body" name: "tapi.connectivity.getconnectionendpointdetails.Input.body-param" @@ -18989,6 +18778,8 @@ paths: post: tags: - "tapi-connectivity" + summary: "operates on tapi.connectivity.GetConnectivityServiceDetails" + description: "operates on tapi.connectivity.GetConnectivityServiceDetails" parameters: - in: "body" name: "tapi.connectivity.getconnectivityservicedetails.Input.body-param" @@ -19024,6 +18815,8 @@ paths: post: tags: - "tapi-topology" + summary: "operates on tapi.topology.GetLinkDetails" + description: "operates on tapi.topology.GetLinkDetails" parameters: - in: "body" name: "tapi.topology.getlinkdetails.Input.body-param" @@ -19045,6 +18838,8 @@ paths: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.GetMeg" + description: "operates on tapi.oam.GetMeg" parameters: - in: "body" name: "tapi.oam.getmeg.Input.body-param" @@ -19066,6 +18861,8 @@ paths: post: tags: - "tapi-topology" + summary: "operates on tapi.topology.GetNodeDetails" + description: "operates on tapi.topology.GetNodeDetails" parameters: - in: "body" name: "tapi.topology.getnodedetails.Input.body-param" @@ -19087,6 +18884,8 @@ paths: post: tags: - "tapi-topology" + summary: "operates on tapi.topology.GetNodeEdgePointDetails" + description: "operates on tapi.topology.GetNodeEdgePointDetails" parameters: - in: "body" name: "tapi.topology.getnodeedgepointdetails.Input.body-param" @@ -19108,6 +18907,8 @@ paths: post: tags: - "tapi-notification" + summary: "operates on tapi.notification.GetNotificationList" + description: "operates on tapi.notification.GetNotificationList" parameters: - in: "body" name: "tapi.notification.getnotificationlist.Input.body-param" @@ -19129,6 +18930,8 @@ paths: post: tags: - "tapi-notification" + summary: "operates on tapi.notification.GetNotificationSubscriptionServiceDetails" + description: "operates on tapi.notification.GetNotificationSubscriptionServiceDetails" parameters: - in: "body" name: "tapi.notification.getnotificationsubscriptionservicedetails.Input.body-param" @@ -19160,10 +18963,26 @@ paths: description: "No response" 400: description: "Internal error" + /operations/get-oam-job-list/: + post: + tags: + - "tapi-oam" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetOamJobList" + 201: + description: "No response" + 400: + description: "Internal error" /operations/get-oam-job/: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.GetOamJob" + description: "operates on tapi.oam.GetOamJob" parameters: - in: "body" name: "tapi.oam.getoamjob.Input.body-param" @@ -19181,23 +19000,39 @@ paths: description: "No response" 400: description: "Internal error" - /operations/get-oam-service-end-point/: + /operations/get-oam-profile-list/: + post: + tags: + - "tapi-oam" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetOamProfileList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-oam-profile/: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.GetOamProfile" + description: "operates on tapi.oam.GetOamProfile" parameters: - in: "body" - name: "tapi.oam.getoamserviceendpoint.Input.body-param" + name: "tapi.oam.getoamprofile.Input.body-param" required: false schema: properties: input: - $ref: "#/definitions/tapi.oam.getoamserviceendpoint.Input" + $ref: "#/definitions/tapi.oam.getoamprofile.Input" responses: 200: description: "Correct response" schema: - $ref: "#/definitions/tapi.oam.GetOamServiceEndPoint" + $ref: "#/definitions/tapi.oam.GetOamProfile" 201: description: "No response" 400: @@ -19216,10 +19051,35 @@ paths: description: "No response" 400: description: "Internal error" + /operations/get-oam-service-point/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.GetOamServicePoint" + description: "operates on tapi.oam.GetOamServicePoint" + parameters: + - in: "body" + name: "tapi.oam.getoamservicepoint.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.getoamservicepoint.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetOamServicePoint" + 201: + description: "No response" + 400: + description: "Internal error" /operations/get-oam-service/: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.GetOamService" + description: "operates on tapi.oam.GetOamService" parameters: - in: "body" name: "tapi.oam.getoamservice.Input.body-param" @@ -19241,6 +19101,8 @@ paths: post: tags: - "tapi-common" + summary: "operates on tapi.common.GetServiceInterfacePointDetails" + description: "operates on tapi.common.GetServiceInterfacePointDetails" parameters: - in: "body" name: "tapi.common.getserviceinterfacepointdetails.Input.body-param" @@ -19290,6 +19152,8 @@ paths: post: tags: - "tapi-topology" + summary: "operates on tapi.topology.GetTopologyDetails" + description: "operates on tapi.topology.GetTopologyDetails" parameters: - in: "body" name: "tapi.topology.gettopologydetails.Input.body-param" @@ -19325,6 +19189,8 @@ paths: post: tags: - "tapi-path-computation" + summary: "operates on tapi.path.computation.OptimizeP2PPath" + description: "operates on tapi.path.computation.OptimizeP2PPath" parameters: - in: "body" name: "tapi.path.computation.optimizep2ppath.Input.body-param" @@ -19346,6 +19212,8 @@ paths: post: tags: - "tapi-connectivity" + summary: "operates on tapi.connectivity.UpdateConnectivityService" + description: "operates on tapi.connectivity.UpdateConnectivityService" parameters: - in: "body" name: "tapi.connectivity.updateconnectivityservice.Input.body-param" @@ -19367,6 +19235,8 @@ paths: post: tags: - "tapi-notification" + summary: "operates on tapi.notification.UpdateNotificationSubscriptionService" + description: "operates on tapi.notification.UpdateNotificationSubscriptionService" parameters: - in: "body" name: "tapi.notification.updatenotificationsubscriptionservice.Input.body-param" @@ -19388,6 +19258,8 @@ paths: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.UpdateOamJob" + description: "operates on tapi.oam.UpdateOamJob" parameters: - in: "body" name: "tapi.oam.updateoamjob.Input.body-param" @@ -19405,23 +19277,48 @@ paths: description: "No response" 400: description: "Internal error" - /operations/update-oam-service-end-point/: + /operations/update-oam-profile/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.UpdateOamProfile" + description: "operates on tapi.oam.UpdateOamProfile" + parameters: + - in: "body" + name: "tapi.oam.updateoamprofile.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.updateoamprofile.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.UpdateOamProfile" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/update-oam-service-point/: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.UpdateOamServicePoint" + description: "operates on tapi.oam.UpdateOamServicePoint" parameters: - in: "body" - name: "tapi.oam.updateoamserviceendpoint.Input.body-param" + name: "tapi.oam.updateoamservicepoint.Input.body-param" required: false schema: properties: input: - $ref: "#/definitions/tapi.oam.updateoamserviceendpoint.Input" + $ref: "#/definitions/tapi.oam.updateoamservicepoint.Input" responses: 200: description: "Correct response" schema: - $ref: "#/definitions/tapi.oam.UpdateOamServiceEndPoint" + $ref: "#/definitions/tapi.oam.UpdateOamServicePoint" 201: description: "No response" 400: @@ -19430,6 +19327,8 @@ paths: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.UpdateOamService" + description: "operates on tapi.oam.UpdateOamService" parameters: - in: "body" name: "tapi.oam.updateoamservice.Input.body-param" @@ -19451,6 +19350,8 @@ paths: post: tags: - "tapi-common" + summary: "operates on tapi.common.UpdateServiceInterfacePoint" + description: "operates on tapi.common.UpdateServiceInterfacePoint" parameters: - in: "body" name: "tapi.common.updateserviceinterfacepoint.Input.body-param" @@ -19482,45 +19383,9 @@ definitions: enum: - "LOCKED" - "UNLOCKED" - tapi.common.BandwidthProfile: - type: "object" - properties: - committed-information-rate: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - coupling-flag: - type: "boolean" - description: "none" - default: false - bw-profile-type: - description: "none" - $ref: "#/definitions/tapi.common.BandwidthProfileType" - peak-information-rate: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - committed-burst-size: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - peak-burst-size: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - color-aware: - type: "boolean" - description: "none" - default: false - tapi.common.BandwidthProfileType: - type: "string" - enum: - - "MEF_10.x" - - "RFC_2697" - - "RFC_2698" - - "RFC_4115" tapi.common.Capacity: type: "object" properties: - bandwidth-profile: - description: "none" - $ref: "#/definitions/tapi.common.BandwidthProfile" total-size: description: "Total capacity of the TopologicalEntity in MB/s. In case of\ \ bandwidthProfile, this is expected to same as the committedInformationRate." @@ -19560,12 +19425,20 @@ definitions: $ref: "#/definitions/tapi.common.CapacityUnit" tapi.common.Context: allOf: - - $ref: "#/definitions/tapi.common.TapiContext" + - $ref: "#/definitions/tapi.common.GlobalClass" - $ref: "#/definitions/tapi.connectivity.ContextAugmentation4" - $ref: "#/definitions/tapi.notification.ContextAugmentation1" - - $ref: "#/definitions/tapi.oam.ContextAugmentation2" - - $ref: "#/definitions/tapi.path.computation.ContextAugmentation3" + - $ref: "#/definitions/tapi.oam.ContextAugmentation3" + - $ref: "#/definitions/tapi.path.computation.ContextAugmentation2" - $ref: "#/definitions/tapi.topology.ContextAugmentation5" + - type: "object" + properties: + service-interface-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.context.ServiceInterfacePoint" + description: "none" tapi.common.DirectiveValue: type: "string" enum: @@ -19595,21 +19468,21 @@ definitions: properties: name: type: "array" - description: "List of names. A property of an entity with a value that is\ - \ unique in some namespace but may change during the life of the entity.\ - \ A name carries no semantics with respect to the purpose of the entity." + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." items: $ref: "#/definitions/tapi.common.NameAndValue" uuid: type: "string" description: "UUID: An identifier that is universally unique within an identifier\ - \ space, where the identifier space is itself globally unique, and immutable.\ - \ An UUID carries no semantics with respect to the purpose or state of the\ - \ entity.\r\n UUID here uses string representation as\ - \ defined in RFC 4122. The canonical representation uses lowercase characters.\r\ - \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ - \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ - \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a UUID\ + \ in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.common.LayerProtocolName: type: "string" enum: @@ -19630,9 +19503,9 @@ definitions: properties: name: type: "array" - description: "List of names. A property of an entity with a value that is\ - \ unique in some namespace but may change during the life of the entity.\ - \ A name carries no semantics with respect to the purpose of the entity." + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." items: $ref: "#/definitions/tapi.common.NameAndValue" local-id: @@ -19694,7 +19567,7 @@ definitions: $ref: "#/definitions/tapi.common.LayerProtocolName" description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ \ termination and adaptation functions of one or more transport layers. \r\ - \n The structure of LTP supports all transport protocols including\ + \n The structure of LTP supports all transport protocols including\ \ circuit and packet forms." tapi.common.ServiceInterfacePointRef: type: "object" @@ -19703,20 +19576,6 @@ definitions: type: "string" description: "none" x-path: "/tapi-common:context/tapi-common:service-interface-point/tapi-common:uuid" - tapi.common.TapiContext: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - service-interface-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - description: "The Network Control Domain (NCD) object class represents the scope\ - \ of control that a particular SDN controller has with respect to a particular\ - \ network, (i.e., encompassing a designated set of interconnected (virtual)\ - \ network elements)." tapi.common.TerminationDirection: type: "string" enum: @@ -19728,11 +19587,11 @@ definitions: type: "object" properties: termination-direction: - description: "The overall directionality of the LP. \r\n \ - \ - A BIDIRECTIONAL LP will have some SINK and/or SOURCE flowss.\r\n \ - \ - A SINK LP can only contain elements with SINK flows\ - \ or CONTRA_DIRECTION_SOURCE flows\r\n - A SOURCE LP\ - \ can only contain SOURCE flows or CONTRA_DIRECTION_SINK flows" + description: "The overall directionality of the LP. \r\n -\ + \ A BIDIRECTIONAL LP will have some SINK and/or SOURCE flowss.\r\n \ + \ - A SINK LP can only contain elements with SINK flows or CONTRA_DIRECTION_SOURCE\ + \ flows\r\n - A SOURCE LP can only contain SOURCE flows or\ + \ CONTRA_DIRECTION_SINK flows" $ref: "#/definitions/tapi.common.TerminationDirection" termination-state: description: "Indicates whether the layer is terminated and if so how." @@ -19787,18 +19646,29 @@ definitions: - "MICROSECONDS" - "NANOSECONDS" - "PICOSECONDS" + tapi.common.context.ServiceInterfacePoint: + allOf: + - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + - $ref: "#/definitions/tapi.eth.ServiceInterfacePointAugmentation1" tapi.common.getserviceinterfacepointdetails.Input: type: "object" properties: - sip-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.common.getserviceinterfacepointdetails.Output: type: "object" properties: sip: description: "none" - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + $ref: "#/definitions/tapi.common.getserviceinterfacepointlist.output.Sip" tapi.common.getserviceinterfacepointlist.Output: type: "object" properties: @@ -19806,13 +19676,24 @@ definitions: type: "array" description: "none" items: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + $ref: "#/definitions/tapi.common.getserviceinterfacepointlist.output.Sip" + tapi.common.getserviceinterfacepointlist.output.Sip: + allOf: + - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + - $ref: "#/definitions/tapi.eth.SipAugmentation1" tapi.common.updateserviceinterfacepoint.Input: type: "object" properties: - sip-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" state: description: "none" $ref: "#/definitions/tapi.common.AdministrativeState" @@ -19832,11 +19713,11 @@ definitions: description: "An Connection object supports a recursive aggregation relationship\ \ such that the internal construction of an Connection can be exposed\ \ as multiple lower level Connection objects (partitioning).\r\n \ - \ Aggregation is used as for the Node/Topology to allow\ - \ changes in hierarchy. \r\n Connection aggregation\ - \ reflects Node/Topology aggregation. \r\n The FC represents\ - \ a Cross-Connection in an NE. The Cross-Connection in an NE is not necessarily\ - \ the lowest level of FC partitioning." + \ Aggregation is used as for the Node/Topology to allow changes\ + \ in hierarchy. \r\n Connection aggregation reflects Node/Topology\ + \ aggregation. \r\n The FC represents a Cross-Connection\ + \ in an NE. The Cross-Connection in an NE is not necessarily the lowest\ + \ level of FC partitioning." items: $ref: "#/definitions/tapi.connectivity.ConnectionRef" switch-control: @@ -19849,6 +19730,9 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.connectivity.Route" + bounding-node: + description: "none" + $ref: "#/definitions/tapi.topology.NodeRef" layer-protocol-name: description: "none" $ref: "#/definitions/tapi.common.LayerProtocolName" @@ -19862,9 +19746,8 @@ definitions: $ref: "#/definitions/tapi.common.ForwardingDirection" description: "The ForwardingConstruct (FC) object class models enabled potential\ \ for forwarding between two or more LTPs and like the LTP supports any transport\ - \ protocol including all circuit and packet forms.\r\n At the\ - \ lowest level of recursion, a FC represents a cross-connection within an\ - \ NE." + \ protocol including all circuit and packet forms.\r\n At the lowest\ + \ level of recursion, a FC represents a cross-connection within an NE." tapi.connectivity.ConnectionEndPoint: allOf: - $ref: "#/definitions/tapi.common.GlobalClass" @@ -19872,6 +19755,9 @@ definitions: - $ref: "#/definitions/tapi.common.TerminationPac" - type: "object" properties: + protection-role: + description: "none" + $ref: "#/definitions/tapi.connectivity.ProtectionRole" client-node-edge-point: type: "array" description: "none" @@ -19901,7 +19787,7 @@ definitions: $ref: "#/definitions/tapi.common.PortDirection" description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ \ termination and adaptation functions of one or more transport layers. \r\ - \n The structure of LTP supports all transport protocols including\ + \n The structure of LTP supports all transport protocols including\ \ circuit and packet forms." tapi.connectivity.ConnectionEndPointRef: allOf: @@ -19911,7 +19797,7 @@ definitions: connection-end-point-uuid: type: "string" description: "none" - x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:owned-node-edge-point/tapi-connectivity:cep-list/tapi-connectivity:connection-end-point/tapi-connectivity:uuid" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:node-edge-point/tapi-connectivity:cep-list/tapi-connectivity:connection-end-point/tapi-connectivity:uuid" description: "none" tapi.connectivity.ConnectionRef: type: "object" @@ -19923,15 +19809,9 @@ definitions: tapi.connectivity.ConnectivityConstraint: type: "object" properties: - service-layer: - description: "none" - $ref: "#/definitions/tapi.common.LayerProtocolName" schedule: description: "none" $ref: "#/definitions/tapi.common.TimeRange" - connectivity-direction: - description: "none" - $ref: "#/definitions/tapi.common.ForwardingDirection" requested-capacity: description: "none" $ref: "#/definitions/tapi.common.Capacity" @@ -19944,51 +19824,13 @@ definitions: type: "string" description: "An abstract value the meaning of which is mutually agreed \ \ typically represents metrics such as - Class of service, priority, resiliency,\ - \ availability" + \ availability\r\n Class of Service Name." service-type: description: "none" $ref: "#/definitions/tapi.connectivity.ServiceType" coroute-inclusion: description: "none" $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" - tapi.connectivity.ConnectivityContext: - type: "object" - properties: - connectivity-service: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.connectivity.ConnectivityService" - connection: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.connectivity.Connection" - tapi.connectivity.ConnectivityService: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" - - $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" - - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - - type: "object" - properties: - end-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" - connection: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.connectivity.ConnectionRef" - description: "The ForwardingConstruct (FC) object class models enabled potential\ - \ for forwarding between two or more LTPs and like the LTP supports any transport\ - \ protocol including all circuit and packet forms.\r\n At the\ - \ lowest level of recursion, a FC represents a cross-connection within an\ - \ NE." tapi.connectivity.ConnectivityServiceEndPoint: allOf: - $ref: "#/definitions/tapi.common.AdminStatePac" @@ -20007,6 +19849,9 @@ definitions: service-interface-point: description: "none" $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + peer-fwd-connectivity-service-end-point: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" layer-protocol-name: description: "none" $ref: "#/definitions/tapi.common.LayerProtocolName" @@ -20018,23 +19863,29 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.connectivity.ConnectionEndPointRef" + server-connectivity-service-end-point: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" direction: description: "The orientation of defined flow at the EndPoint." $ref: "#/definitions/tapi.common.PortDirection" capacity: description: "none" $ref: "#/definitions/tapi.common.Capacity" + protecting-connectivity-service-end-point: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" description: "The association of the FC to LTPs is made via EndPoints.\r\n \ - \ The EndPoint (EP) object class models the access to the FC\ - \ function. \r\n The traffic forwarding between the associated\ - \ EPs of the FC depends upon the type of FC and may be associated with FcSwitch\ - \ object instances. \r\n In cases where there is resilience\ - \ the EndPoint may convey the resilience role of the access to the FC. \r\n\ - \ It can represent a protected (resilient/reliable) point or\ - \ a protecting (unreliable working or protection) point.\r\n \ - \ The EP replaces the Protection Unit of a traditional protection model.\ - \ \r\n The ForwadingConstruct can be considered as a component\ - \ and the EndPoint as a Port on that component" + \ The EndPoint (EP) object class models the access to the FC function.\ + \ \r\n The traffic forwarding between the associated EPs of the\ + \ FC depends upon the type of FC and may be associated with FcSwitch object\ + \ instances. \r\n In cases where there is resilience the EndPoint\ + \ may convey the resilience role of the access to the FC. \r\n \ + \ It can represent a protected (resilient/reliable) point or a protecting\ + \ (unreliable working or protection) point.\r\n The EP replaces\ + \ the Protection Unit of a traditional protection model. \r\n The\ + \ ForwadingConstruct can be considered as a component and the EndPoint as\ + \ a Port on that component" tapi.connectivity.ConnectivityServiceEndPointRef: allOf: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" @@ -20057,7 +19908,7 @@ definitions: properties: connectivity-context: description: "Augments the base TAPI Context with ConnectivityService information" - $ref: "#/definitions/tapi.connectivity.ConnectivityContext" + $ref: "#/definitions/tapi.connectivity.context.ConnectivityContext" x-augmentation: prefix: "tapi-connectivity" namespace: "urn:onf:otcc:yang:tapi-connectivity" @@ -20092,12 +19943,12 @@ definitions: properties: output: $ref: "#/definitions/tapi.connectivity.getconnectivityservicelist.Output" - tapi.connectivity.OwnedNodeEdgePointAugmentation1: + tapi.connectivity.NodeEdgePointAugmentation1: type: "object" properties: cep-list: description: "none" - $ref: "#/definitions/tapi.connectivity.context.topologycontext.topology.node.ownednodeedgepoint.CepList" + $ref: "#/definitions/tapi.connectivity.context.topologycontext.topology.node.nodeedgepoint.CepList" x-augmentation: prefix: "tapi-connectivity" namespace: "urn:onf:otcc:yang:tapi-connectivity" @@ -20116,40 +19967,26 @@ definitions: is-lock-out: type: "boolean" description: "The resource is configured to temporarily not be available for\ - \ use in the protection scheme(s) it is part of.\r\n \ - \ This overrides all other protection control states including forced.\r\ - \n If the item is locked out then it cannot be used under\ - \ any circumstances.\r\n Note: Only relevant when part\ - \ of a protection scheme." + \ use in the protection scheme(s) it is part of.\r\n This\ + \ overrides all other protection control states including forced.\r\n \ + \ If the item is locked out then it cannot be used under any\ + \ circumstances.\r\n Note: Only relevant when part of a protection\ + \ scheme." default: false max-switch-times: type: "integer" format: "int32" description: "Used to limit the maximum swtich times. When work fault disappears\ \ , and traffic return to the original work path, switch counter reset." - restoration-coordinate-type: - description: " The coordination mechanism between multi-layers." - $ref: "#/definitions/tapi.connectivity.CoordinateType" - is-coordinated-switching-both-ends: - type: "boolean" - description: "Is operating such that switching at both ends of each flow acorss\ - \ the FC is coordinated at both ingress and egress ends." - default: false + protection-type: + description: "none" + $ref: "#/definitions/tapi.topology.ProtectionType" hold-off-time: type: "integer" format: "int32" description: "This attribute indicates the time, in milliseconds, between\ \ declaration of signal degrade or signal fail, and the initialization of\ \ the protection switching algorithm." - is-frozen: - type: "boolean" - description: "Temporarily prevents any switch action to be taken and, as such,\ - \ freezes the current state. \r\n Until the freeze is\ - \ cleared, additional near-end external commands are rejected and fault\ - \ condition changes and received APS messages are ignored.\r\n \ - \ All administrative controls of any aspect of protection are\ - \ rejected." - default: false wait-to-revert-time: type: "integer" format: "int32" @@ -20157,9 +19994,9 @@ definitions: \ the time, in minutes, to wait after a fault clears on a higher priority\ \ (preferred) resource before reverting to the preferred resource." default: 15 - resilience-type: - description: "none" - $ref: "#/definitions/tapi.topology.ResilienceType" + selection-control: + description: "Degree of administrative control applied to the switch selection." + $ref: "#/definitions/tapi.connectivity.SelectionControl" preferred-restoration-layer: type: "array" description: "Indicate which layer this resilience parameters package configured\ @@ -20170,6 +20007,28 @@ definitions: type: "integer" format: "int32" description: "none" + restoration-policy: + description: "none" + $ref: "#/definitions/tapi.topology.RestorationPolicy" + restoration-coordinate-type: + description: " The coordination mechanism between multi-layers." + $ref: "#/definitions/tapi.connectivity.CoordinateType" + is-coordinated-switching-both-ends: + type: "boolean" + description: "Is operating such that switching at both ends of each flow acorss\ + \ the FC is coordinated at both ingress and egress ends." + default: false + fault-condition-determination: + type: "string" + description: "none" + is-frozen: + type: "boolean" + description: "Temporarily prevents any switch action to be taken and, as such,\ + \ freezes the current state. \r\n Until the freeze is cleared,\ + \ additional near-end external commands are rejected and fault condition\ + \ changes and received APS messages are ignored.\r\n All\ + \ administrative controls of any aspect of protection are rejected." + default: false reversion-mode: description: "Indcates whether the protection scheme is revertive or non-revertive." $ref: "#/definitions/tapi.connectivity.ReversionMode" @@ -20189,9 +20048,9 @@ definitions: items: $ref: "#/definitions/tapi.connectivity.ConnectionEndPointRef" description: "The FC Route (FcRoute) object class models the individual routes\ - \ of an FC. \r\n The route of an FC object is represented by\ - \ a list of FCs at a lower level. \r\n Note that depending\ - \ on the service supported by an FC, an the FC can have multiple routes." + \ of an FC. \r\n The route of an FC object is represented by a\ + \ list of FCs at a lower level. \r\n Note that depending on the\ + \ service supported by an FC, an the FC can have multiple routes." tapi.connectivity.RouteRef: allOf: - $ref: "#/definitions/tapi.connectivity.ConnectionRef" @@ -20241,9 +20100,6 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.connectivity.RouteRef" - selection-control: - description: "Degree of administrative control applied to the switch selection." - $ref: "#/definitions/tapi.connectivity.SelectionControl" selection-reason: description: "The reason for the current switch selection." $ref: "#/definitions/tapi.connectivity.SelectionReason" @@ -20253,32 +20109,31 @@ definitions: $ref: "#/definitions/tapi.common.PortDirection" description: "The class models the switched forwarding of traffic (traffic flow)\ \ between FcPorts (ConnectionEndPoints) and is present where there is protection\ - \ functionality in the FC (Connection). \r\n If an FC exposes\ - \ protection (having two or more FcPorts that provide alternative identical\ - \ inputs/outputs), the FC will have one or more associated FcSwitch objects\ - \ to represent the alternative flow choices visible at the edge of the FC.\r\ - \n The FC switch represents and defines a protection switch\ - \ structure encapsulated in the FC. \r\n Essentially performs\ - \ one of the functions of the Protection Group in a traditional model. It\ - \ associates to 2 or more FcPorts each playing the role of a Protection Unit.\ - \ \r\n One or more protection, i.e. standby/backup, FcPorts\ - \ provide protection for one or more working (i.e. regular/main/preferred)\ - \ FcPorts where either protection or working can feed one or more protected\ - \ FcPort.\r\n The switch may be used in revertive or non-revertive\ - \ (symmetric) mode. When in revertive mode it may define a waitToRestore time.\r\ - \n It may be used in one of several modes including source\ - \ switch, destination switched, source and destination switched etc (covering\ - \ cases such as 1+1 and 1:1).\r\n It may be locked out (prevented\ - \ from switching), force switched or manual switched.\r\n It\ - \ will indicate switch state and change of state.\r\n The switch\ - \ can be switched away from all sources such that it becomes open and hence\ - \ two coordinated switches can both feed the same LTP so long as at least\ - \ one of the two is switched away from all sources (is 'open').\r\n \ - \ The ability for a Switch to be 'high impedance' allows bidirectional\ - \ ForwardingConstructs to be overlaid on the same bidirectional LTP where\ - \ the appropriate control is enabled to prevent signal conflict.\r\n \ - \ This ability allows multiple alternate routes to be present that\ - \ otherwise would be in conflict." + \ functionality in the FC (Connection). \r\n If an FC exposes protection\ + \ (having two or more FcPorts that provide alternative identical inputs/outputs),\ + \ the FC will have one or more associated FcSwitch objects to represent the\ + \ alternative flow choices visible at the edge of the FC.\r\n The\ + \ FC switch represents and defines a protection switch structure encapsulated\ + \ in the FC. \r\n Essentially performs one of the functions of\ + \ the Protection Group in a traditional model. It associates to 2 or more\ + \ FcPorts each playing the role of a Protection Unit. \r\n One\ + \ or more protection, i.e. standby/backup, FcPorts provide protection for\ + \ one or more working (i.e. regular/main/preferred) FcPorts where either protection\ + \ or working can feed one or more protected FcPort.\r\n The switch\ + \ may be used in revertive or non-revertive (symmetric) mode. When in revertive\ + \ mode it may define a waitToRestore time.\r\n It may be used in\ + \ one of several modes including source switch, destination switched, source\ + \ and destination switched etc (covering cases such as 1+1 and 1:1).\r\n \ + \ It may be locked out (prevented from switching), force switched\ + \ or manual switched.\r\n It will indicate switch state and change\ + \ of state.\r\n The switch can be switched away from all sources\ + \ such that it becomes open and hence two coordinated switches can both feed\ + \ the same LTP so long as at least one of the two is switched away from all\ + \ sources (is 'open').\r\n The ability for a Switch to be 'high\ + \ impedance' allows bidirectional ForwardingConstructs to be overlaid on the\ + \ same bidirectional LTP where the appropriate control is enabled to prevent\ + \ signal conflict.\r\n This ability allows multiple alternate routes\ + \ to be present that otherwise would be in conflict." tapi.connectivity.SwitchControl: allOf: - $ref: "#/definitions/tapi.common.GlobalClass" @@ -20316,9 +20171,66 @@ definitions: tapi.connectivity.ceplist.ConnectionEndPoint: allOf: - $ref: "#/definitions/tapi.connectivity.ConnectionEndPoint" - - $ref: "#/definitions/tapi.eth.ConnectionEndPointAugmentation1" - - $ref: "#/definitions/tapi.oam.ConnectionEndPointAugmentation2" - tapi.connectivity.context.topologycontext.topology.node.ownednodeedgepoint.CepList: + - $ref: "#/definitions/tapi.eth.ConnectionEndPointAugmentation2" + - $ref: "#/definitions/tapi.oam.ConnectionEndPointAugmentation1" + tapi.connectivity.connectivitycontext.ConnectivityService: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.eth.ConnectivityServiceAugmentation1" + - type: "object" + properties: + topology-constraint: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + end-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" + resilience-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + connection: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.ConnectionRef" + connectivity-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + direction: + description: "none" + $ref: "#/definitions/tapi.common.ForwardingDirection" + description: "none" + tapi.connectivity.connectivityservice.EndPoint: + allOf: + - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" + - $ref: "#/definitions/tapi.eth.EndPointAugmentation1" + tapi.connectivity.context.ConnectivityContext: + allOf: + - type: "object" + properties: + connectivity-service: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.connectivitycontext.ConnectivityService" + connection: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.Connection" + description: "Augments the base TAPI Context with ConnectivityService information" + tapi.connectivity.context.topologycontext.topology.node.nodeedgepoint.CepList: allOf: - type: "object" properties: @@ -20332,43 +20244,117 @@ definitions: type: "object" properties: topology-constraint: + type: "array" description: "none" - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" end-point: type: "array" description: "none" items: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" + $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" resilience-constraint: description: "none" $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" routing-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.RoutingConstraint" state: - type: "string" description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" connectivity-constraint: description: "none" $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.connectivity.createconnectivityservice.Output: type: "object" properties: service: description: "none" - $ref: "#/definitions/tapi.connectivity.ConnectivityService" + $ref: "#/definitions/tapi.connectivity.createconnectivityservice.output.Service" + tapi.connectivity.createconnectivityservice.output.Service: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.eth.ServiceAugmentation1" + - type: "object" + properties: + topology-constraint: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + end-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" + resilience-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + connection: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.ConnectionRef" + connectivity-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + direction: + description: "none" + $ref: "#/definitions/tapi.common.ForwardingDirection" + description: "none" tapi.connectivity.deleteconnectivityservice.Input: type: "object" properties: - service-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.connectivity.getconnectiondetails.Input: type: "object" properties: - connection-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.connectivity.getconnectiondetails.Output: type: "object" properties: @@ -20378,18 +20364,16 @@ definitions: tapi.connectivity.getconnectionendpointdetails.Input: type: "object" properties: - cep-id-or-name: - type: "string" - description: "none" - nep-id-or-name: - type: "string" - description: "none" - node-id-or-name: - type: "string" - description: "none" - topology-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.connectivity.getconnectionendpointdetails.Output: type: "object" properties: @@ -20399,15 +20383,60 @@ definitions: tapi.connectivity.getconnectivityservicedetails.Input: type: "object" properties: - service-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.connectivity.getconnectivityservicedetails.Output: type: "object" properties: service: description: "none" - $ref: "#/definitions/tapi.connectivity.ConnectivityService" + $ref: "#/definitions/tapi.connectivity.getconnectivityservicedetails.output.Service" + tapi.connectivity.getconnectivityservicedetails.output.Service: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.eth.ServiceAugmentation1" + - type: "object" + properties: + topology-constraint: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + end-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" + resilience-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + connection: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.ConnectionRef" + connectivity-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + direction: + description: "none" + $ref: "#/definitions/tapi.common.ForwardingDirection" + description: "none" tapi.connectivity.getconnectivityservicelist.Output: type: "object" properties: @@ -20415,39 +20444,131 @@ definitions: type: "array" description: "none" items: - $ref: "#/definitions/tapi.connectivity.ConnectivityService" + $ref: "#/definitions/tapi.connectivity.getconnectivityservicelist.output.Service" + tapi.connectivity.getconnectivityservicelist.output.Service: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.eth.ServiceAugmentation1" + - type: "object" + properties: + topology-constraint: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + end-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" + resilience-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + connection: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.ConnectionRef" + connectivity-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + direction: + description: "none" + $ref: "#/definitions/tapi.common.ForwardingDirection" + description: "none" tapi.connectivity.updateconnectivityservice.Input: type: "object" properties: - service-id-or-name: - type: "string" - description: "none" topology-constraint: + type: "array" description: "none" - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" end-point: type: "array" description: "none" items: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" + $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" resilience-constraint: description: "none" $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" routing-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.RoutingConstraint" state: - type: "string" description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" connectivity-constraint: description: "none" $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.connectivity.updateconnectivityservice.Output: type: "object" properties: service: description: "none" - $ref: "#/definitions/tapi.connectivity.ConnectivityService" + $ref: "#/definitions/tapi.connectivity.updateconnectivityservice.output.Service" + tapi.connectivity.updateconnectivityservice.output.Service: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.eth.ServiceAugmentation1" + - type: "object" + properties: + topology-constraint: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + end-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" + resilience-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + connection: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.ConnectionRef" + connectivity-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + direction: + description: "none" + $ref: "#/definitions/tapi.common.ForwardingDirection" + description: "none" tapi.eth.BandwidthReport: type: "object" properties: @@ -20471,7 +20592,7 @@ definitions: enum: - "COLOUR_BLIND" - "COLOUR_AWARE" - tapi.eth.ConnectionEndPointAugmentation1: + tapi.eth.ConnectionEndPointAugmentation2: type: "object" properties: eth-connection-end-point-spec: @@ -20481,6 +20602,15 @@ definitions: x-augmentation: prefix: "tapi-eth" namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.ConnectivityServiceAugmentation1: + type: "object" + properties: + eth-connectivity-service: + description: "none" + $ref: "#/definitions/tapi.eth.EthConnectivityService" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" tapi.eth.ControlFrameFilter: type: "object" properties: @@ -20632,30 +20762,325 @@ definitions: - "ENABLED_WITH_RDI_FDI" - "ENABLED_WITH_RDI_FDI_DCI" - "ENABLED_WITH_DCI" - tapi.eth.Eth1DmThresholdData: + tapi.eth.CurrentDataAugmentation1: type: "object" properties: - near-end-1-dm-cross-threshold: - description: "This attribute contains the near end cross threshold values\ - \ of the delay measurements." - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - near-end-1-dm-clear-threshold: - description: "This attribute contains the near end clear threshold values\ - \ of the delay measurements." - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - tapi.eth.Eth1LmThresholdData: + eth-pro-active-1-lm-source-performance-data: + description: "none" + $ref: "#/definitions/tapi.eth.EthProActive1LmSourcePerformanceData" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.CurrentDataAugmentation10: type: "object" properties: - near-end-1-lm-cross-threshold: - description: "This attribute contains the near end cross threshold values\ - \ of the loss measurements." - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" - near-end-1-lm-clear-threshold: - description: "This attribute is only valid for frame loss ratio parameters\ - \ and counter type parameters working in the 'standing condition method'\ - \ (see G.7710, section 10.1.7.2: Threshold reporting) and contains the near\ - \ end clear threshold values of the loss measurements." - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" + eth-on-demand-lm-performance-data: + description: "none" + $ref: "#/definitions/tapi.eth.EthOnDemandLmPerformanceData" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.CurrentDataAugmentation11: + type: "object" + properties: + eth-link-trace-result-data: + description: "none" + $ref: "#/definitions/tapi.eth.EthLinkTraceResultData" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.CurrentDataAugmentation12: + type: "object" + properties: + eth-pro-active-1-dm-source-performance-data: + description: "none" + $ref: "#/definitions/tapi.eth.EthProActive1DmSourcePerformanceData" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.CurrentDataAugmentation13: + type: "object" + properties: + eth-test-result-data: + description: "none" + $ref: "#/definitions/tapi.eth.EthTestResultData" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.CurrentDataAugmentation14: + type: "object" + properties: + eth-pro-active-dm-performance-data: + description: "none" + $ref: "#/definitions/tapi.eth.EthProActiveDmPerformanceData" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.CurrentDataAugmentation15: + type: "object" + properties: + eth-pro-active-lm-performance-data: + description: "none" + $ref: "#/definitions/tapi.eth.EthProActiveLmPerformanceData" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.CurrentDataAugmentation2: + type: "object" + properties: + eth-on-demand-1-lm-source-performance-data: + description: "none" + $ref: "#/definitions/tapi.eth.EthOnDemand1LmSourcePerformanceData" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.CurrentDataAugmentation3: + type: "object" + properties: + eth-on-demand-1-lm-performance-data: + description: "none" + $ref: "#/definitions/tapi.eth.EthOnDemand1LmPerformanceData" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.CurrentDataAugmentation4: + type: "object" + properties: + eth-on-demand-dm-performance-data: + description: "none" + $ref: "#/definitions/tapi.eth.EthOnDemandDmPerformanceData" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.CurrentDataAugmentation5: + type: "object" + properties: + eth-on-demand-1-dm-source-performance-data: + description: "none" + $ref: "#/definitions/tapi.eth.EthOnDemand1DmSourcePerformanceData" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.CurrentDataAugmentation6: + type: "object" + properties: + eth-on-demand-1-dm-performance-data: + description: "none" + $ref: "#/definitions/tapi.eth.EthOnDemand1DmPerformanceData" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.CurrentDataAugmentation7: + type: "object" + properties: + eth-pro-active-1-lm-performance-data: + description: "none" + $ref: "#/definitions/tapi.eth.EthProActive1LmPerformanceData" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.CurrentDataAugmentation8: + type: "object" + properties: + eth-pro-active-1-dm-performance-data: + description: "none" + $ref: "#/definitions/tapi.eth.EthProActive1DmPerformanceData" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.CurrentDataAugmentation9: + type: "object" + properties: + eth-loopback-result-data: + description: "none" + $ref: "#/definitions/tapi.eth.EthLoopbackResultData" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.EndPointAugmentation1: + type: "object" + properties: + eth-connectivity-service-end-point-spec: + description: "none" + $ref: "#/definitions/tapi.eth.EthConnectivityServiceEndPointSpec" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.EthCfmLinkTracePac: + type: "object" + properties: + period: + description: "IEEE P802.1Qcx/D0.3:\r\n The interval between\ + \ LTM transmissions to be used by all MEPs in the Maintenance Association." + $ref: "#/definitions/tapi.eth.OamPeriod" + target-mep-id: + type: "integer" + format: "int32" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ An indication of a destination MEP, the MEPID of a MEP.\r\n \ + \ Alternative to destination MAC address.\r\n \ + \ " + drop-eligibility: + type: "boolean" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ Drop eligible bit value to be used in the VLAN tag, if present\ + \ in the transmitted frame." + default: false + ltm-flags: + type: "string" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ The flags field for the LTMs transmitted by the MEP." + tapi.eth.EthCfmLinkTraceResultData: + type: "object" + properties: + egress-action-field: + type: "string" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ An enumerated value indicating the value returned in the Egress\ + \ Action field.\r\n IEEE P802.1Qcx/D0.3:\r\n \ + \ The value EGRESS-NO-TLV indicates that no Reply Egress TLV was returned\ + \ in the LTM." + receive-order: + type: "integer" + format: "int32" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ type uint32 range '1..4294967295'\r\n An index to\ + \ distinguish among multiple LTRs with the same LTR Transaction Identifier\ + \ field value.\r\n Assigned sequentially from 1, in the order\ + \ that the Linktrace Initiator received the LTRs." + seq-number: + type: "integer" + format: "int32" + description: "IEEE P802.1Qcx/D0.3:\r\n type uint32 range '0..4294967295'\r\ + \n Transaction identifier returned by a previous transmit\ + \ linktrace message command, indicating which LTMs response is going to\ + \ be returned.\r\n MEF 38:\r\n The LTM Transaction\ + \ Identifier to which the LTR entries will be attached." + ingress-port-id: + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ Ingress Port ID.\r\n IEEE P802.1Qcx/D0.3:\r\n \ + \ If the ingressActionField attribute contains the value INGRESS-NO-TLV,\ + \ then the contents of this attribute are meaningless." + $ref: "#/definitions/tapi.eth.LldpPortIdSubtype" + organization-specific-tlv: + type: "string" + description: "String length '0 | 4..1500';\r\n All Organization\ + \ specific TLVs returned in the LTR, if any. Includes all octets including\ + \ and following the TLV Length field of each TLV, concatenated together." + ingress-action-field: + type: "string" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ The value returned in the Ingress Action Field of the LTM.\r\n\ + \ IEEE P802.1Qcx/D0.3:\r\n The value INGRESS-NO-TLV\ + \ indicates that no Reply Ingress TLV was returned in the LTM.\r\n \ + \ " + chassis-id: + description: "MEF 38:\r\n The chassis-id-subtype contains the\ + \ chassis ID entity that is listed in the chassis ID field. This is a combination\ + \ of the 'Chassis ID Subtype' and 'chsssis ID' fields.\r\n \ + \ IEEE P802.1Qcx/D0.3:\r\n The Chassis ID returned in the\ + \ Sender ID TLV of the LTR, if any.\r\n The format of a chassis\ + \ identifier string. Objects of this type are always used with an associated\ + \ lldp-chassis-is-subtype object, which identifies the format of the particular\ + \ lldp-chassis-id object instance.\r\n If the associated\ + \ lldp-chassis-id-subtype object has a value of chassis-component, then\ + \ the octet string identifies a particular instance of the entPhysicalAlias\ + \ object (defined in IETF RFC 2737) for a chassis component (i.e., an entPhysicalClass\ + \ value of chassis(3)).\r\n If the associated lldp-chassis-id-subtype\ + \ object has a value of interface-alias, then the octet string identifies\ + \ a particular instance of the ifAlias object (defined in IETF RFC 2863)\ + \ for an interface on the containing chassis.\r\n If the\ + \ particular ifAlias object does not contain any values, another chassis\ + \ identifier type should be used." + $ref: "#/definitions/tapi.eth.LldpChassisIdSubtype" + forwarded: + type: "boolean" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ Indicates if a LTM was forwarded by the responding MP, as returned\ + \ in the FwdYes flag of the flags field." + default: false + terminal-mep: + type: "boolean" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ A Boolean value stating whether the forwarded LTM reached a MEP\ + \ enclosing its MA, as returned in the Terminal MEP flag of the Flags field." + default: false + ingress-mac: + type: "string" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ MAC address returned in the ingress MAC address field.\r\n \ + \ IEEE P802.1Qcx/D0.3:\r\n If the ingressActionField\ + \ attribute contains the value INGRESS-NO-TLV, then the contents of this\ + \ attribute is meaningless." + egress-port-id: + description: "MEF 38:\r\n IEEE P802.1Qcx/D0.3:\r\n \ + \ Egress Port ID.\r\n IEEE P802.1Qcx/D0.3:\r\n \ + \ If the egressActionField attribute contains the value EGRESS-NO-TLV,\ + \ then the contents of this attribute are meaningless." + $ref: "#/definitions/tapi.eth.LldpPortIdSubtype" + egress-mac: + type: "string" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ MAC address returned in the egress MAC address field.\r\n \ + \ IEEE P802.1Qcx/D0.3:\r\n If the egressActionField\ + \ contains the value EGRESS-NO-TLV, then the contents of this attribute\ + \ are meaningless." + next-egress-identifier: + type: "string" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ String length '8'\r\n An octet field holding the\ + \ Next Egress Identifier returned in the LTR Egress Identifier TLV of the\ + \ LTR.\r\n The Next Egress Identifier Identifies the Linktrace\ + \ Responder that transmitted this LTR, and can forward the LTM to the next\ + \ hop.\r\n This is the same value as the Egress Identifier\ + \ TLV of the forwarded LTM, if any.\r\n If the FwdYes bit\ + \ of the Flags field is false, the contents of this field are undefined,\ + \ i.e., any value can be transmitted, and the field is ignored by the receiver." + last-egress-identifier: + type: "string" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ String length '8'\r\n An octet field holding the\ + \ Last Egress Identifier returned in the LTR Egress Identifier TLV of the\ + \ LTR.\r\n The Last Egress Identifier identifies the MEP\ + \ Linktrace Initiator that originated, or the Linktrace Responder that forwarded,\ + \ the LTM to which this LTR is the response.\r\n This is\ + \ the same value as the Egress Identifier TLV of that LTM." + relay-action-field: + type: "string" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ An enumerated value indicating the value returned in the Relay\ + \ Action field.\r\n " + reply-ttl: + type: "integer" + format: "int32" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ TTL field value for a returned LTR.\r\n Range '0..255'" + tapi.eth.EthCfmMaintenanceAssociation: + type: "object" + properties: + maintenance-association-name: + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ The Maintenance Association name and name format choice." + $ref: "#/definitions/tapi.eth.MaintenanceAssociationName" + id-permission: + type: "string" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ This parameter indicates what, if anything, is to be included in\ + \ the Sender ID TLV transmitted by Maintenance Points configured in this\ + \ MA.\r\n A value of 'defer' means that the contents of the\ + \ Sender ID TLV are determined by the enclosing Maintenance Domain instance." + tapi.eth.EthCfmMaintenanceDomain: + type: "object" + properties: + maintenance-domain-name: + type: "string" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ A reference to the maintenance domain that this maintenance group\ + \ is associated with." + maintenance-domain-name-type: + type: "string" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ The Maintenance Domain name format choice." tapi.eth.EthConnectionEndPointSpec: type: "object" properties: @@ -20668,172 +21093,163 @@ definitions: eth-ctp: description: "none" $ref: "#/definitions/tapi.eth.EthCtpPac" - tapi.eth.EthCtpPac: + tapi.eth.EthConnectivityService: + type: "object" + tapi.eth.EthConnectivityServiceEndPointSpec: type: "object" properties: + eth-ctp-common-pac: + description: "none" + $ref: "#/definitions/tapi.eth.EthCtpCommonPac" + eth-termination-common-pac: + description: "none" + $ref: "#/definitions/tapi.eth.EthTerminationCommonPac" + ety-termination-common-pac: + description: "none" + $ref: "#/definitions/tapi.eth.EtyTerminationCommonPac" + tapi.eth.EthCtpCommonPac: + type: "object" + properties: + vlan-config: + type: "integer" + format: "int32" + description: "This attribute models the ETHx/ETH-m_A_So_MI_Vlan_Config information\ + \ defined in G.8021.\r\n range of type : -1, 0, 1..4094" csf-rdi-fdi-enable: type: "boolean" description: "This attribute models the MI_CSFrdifdiEnable information defined\ \ in G.8021." default: false - vlan-config: - type: "integer" - format: "int32" - description: "This attribute models the ETHx/ETH-m_A_So_MI_Vlan_Config information\ - \ defined in G.8021.\r\n range of type : -1, 0, 1..4094" filter-config: description: "This attribute models the FilterConfig MI defined in section\ \ 8.3/G.8021. It indicates the configured filter action for each of the\ \ 33 group MAC addresses for control frames. The 33 MAC addresses are:\r\ - \n - All bridges address: 01-80-C2-00-00-10,\r\n \ - \ - Reserved addresses: 01-80-C2-00-00-00 to 01-80-C2-00-00-0F,\r\ - \n - GARP Application addresses: 01-80-C2-00-00-20 to\ - \ 01-80-C2-00-00-2F.\r\n The filter action is Pass or\ - \ Block. \r\n If the destination address of the incoming\ - \ ETH_CI_D matches one of the above addresses, the filter process shall\ - \ perform the corresponding configured filter action. \r\n \ - \ If none of the above addresses match, the ETH_CI_D is passed." + \n - All bridges address: 01-80-C2-00-00-10,\r\n \ + \ - Reserved addresses: 01-80-C2-00-00-00 to 01-80-C2-00-00-0F,\r\ + \n - GARP Application addresses: 01-80-C2-00-00-20 to 01-80-C2-00-00-2F.\r\ + \n The filter action is Pass or Block. \r\n \ + \ If the destination address of the incoming ETH_CI_D matches one of the\ + \ above addresses, the filter process shall perform the corresponding configured\ + \ filter action. \r\n If none of the above addresses match,\ + \ the ETH_CI_D is passed." $ref: "#/definitions/tapi.eth.ControlFrameFilter" + traffic-shaping-pac: + description: "none" + $ref: "#/definitions/tapi.eth.TrafficShapingPac" mac-length: type: "integer" format: "int32" description: "This attribute models the MAC_Lenght MI defined in 8.6/G.8021\ \ for the MAC Length Check process. It indicates the allowed maximum frame\ - \ length in bytes.\r\n range of type : 1518, 1522, 2000" + \ length in bytes.\r\n range of type : 1518, 1522, 2000" default: 2000 csf-report: type: "boolean" description: "This attribute models the MI_CSF_Reported information defined\ - \ in G.8021.\r\n range of type : true, false" + \ in G.8021.\r\n range of type : true, false" default: false filter-config-snk: type: "array" description: "This attribute models the FilteConfig MI defined in 8.3/G.8021.\ \ It indicates the configured filter action for each of the 33 group MAC\ \ addresses for control frames. The 33 MAC addresses are:\r\n \ - \ 01-80-C2-00-00-10, \r\n 01-80-C2-00-00-00\ - \ to 01-80-C2-00-00-0F, and \r\n 01-80-C2-00-00-20 to\ - \ 01-80-C2-00-00-2F.\r\n The filter action is Pass or\ - \ Block. \r\n If the destination address of the incoming\ - \ ETH_CI_D matches one of the above addresses, the filter process shall\ - \ perform the corresponding configured filter action. \r\n \ - \ If none of the above addresses match, the ETH_CI_D is passed." + \ 01-80-C2-00-00-10, \r\n 01-80-C2-00-00-00 to 01-80-C2-00-00-0F,\ + \ and \r\n 01-80-C2-00-00-20 to 01-80-C2-00-00-2F.\r\n \ + \ The filter action is Pass or Block. \r\n If\ + \ the destination address of the incoming ETH_CI_D matches one of the above\ + \ addresses, the filter process shall perform the corresponding configured\ + \ filter action. \r\n If none of the above addresses match,\ + \ the ETH_CI_D is passed." + items: + type: "string" + pll-thr: + type: "integer" + format: "int32" + description: "This attribute provisions the threshold for the number of active\ + \ ports. If the number of active ports is more than zero but less than the\ + \ provisioned threshold, a cPLL (Partial Link Loss) is raised. See section\ + \ 9.7.1.2 of G.8021.\r\n range of type : 0..number of ports" + csf-config: + description: "This attribute models the combination of all CSF related MI\ + \ signals (MI_CSF_Enable, MI_CSFrdifdi_Enable, MI_CSFdci_Enable) as defined\ + \ in G.8021.\r\n range of type : true, false" + $ref: "#/definitions/tapi.eth.CsfConfig" + is-ssf-reported: + type: "boolean" + description: "This attribute provisions whether the SSF defect should be reported\ + \ as fault cause or not.\r\n It models the ETH-LAG_FT_Sk_MI_SSF_Reported\ + \ defined in G.8021." + default: false + collector-max-delay: + type: "integer" + format: "int32" + description: "See 802.1AX:\r\n The value of this attribute\ + \ defines the maximum delay, in tens of microseconds, that may be imposed\ + \ by the Frame Collector between receiving a frame from an Aggregator Parser,\ + \ and either delivering the frame to its MAC Client or discarding the frame\ + \ (see IEEE 802.1AX clause 5.2.3.1.1).\r\n range of type\ + \ : 16-bit" + auxiliary-function-position-sequence: + type: "array" + description: "This attribute indicates the positions (i.e., the relative order)\ + \ of all the MEP, MIP, and TCS objects which are associated with the CTP." items: - type: "string" - pll-thr: - type: "integer" - format: "int32" - description: "This attribute provisions the threshold for the number of active\ - \ ports. If the number of active ports is more than zero but less than the\ - \ provisioned threshold, a cPLL (Partial Link Loss) is raised. See section\ - \ 9.7.1.2 of G.8021.\r\n range of type : 0..number of\ - \ ports" - csf-config: - description: "This attribute models the combination of all CSF related MI\ - \ signals (MI_CSF_Enable, MI_CSFrdifdi_Enable, MI_CSFdci_Enable) as defined\ - \ in G.8021.\r\n range of type : true, false" - $ref: "#/definitions/tapi.eth.CsfConfig" - partner-system-id: - type: "string" - description: "See 802.1AX:\r\n A MAC address consisting\ - \ of the unique identifier for the current protocol Partner of this Aggregator.\ - \ A value of zero indicates that there is no known Partner. If the aggregation\ - \ is manually configured, this System ID value will be a value assigned\ - \ by the local System." + type: "integer" + format: "int32" + traffic-conditioning-pac: + description: "none" + $ref: "#/definitions/tapi.eth.TrafficConditioningPac" + tapi.eth.EthCtpPac: + type: "object" + properties: + eth-ctp-common-pac: + description: "none" + $ref: "#/definitions/tapi.eth.EthCtpCommonPac" partner-system-priority: type: "integer" format: "int32" - description: "See 802.1AX:\r\n Indicates the priority associated\ + description: "See 802.1AX:\r\n Indicates the priority associated\ \ with the Partners System ID. If the aggregation is manually configured,\ \ this System Priority value will be a value assigned by the local System.\r\ - \n range of type : 2-octet" + \n range of type : 2-octet" partner-oper-key: type: "integer" format: "int32" - description: "See 802.1AX:\r\n The current operational\ - \ value of the Key for the Aggregators current protocol Partner. If the\ - \ aggregation is manually configured, this Key value will be a value assigned\ - \ by the local System.\r\n range of type : 16-bit" - traffic-conditioning: - description: "none" - $ref: "#/definitions/tapi.eth.TrafficConditioningPac" + description: "See 802.1AX:\r\n The current operational value\ + \ of the Key for the Aggregators current protocol Partner. If the aggregation\ + \ is manually configured, this Key value will be a value assigned by the\ + \ local System.\r\n range of type : 16-bit" actor-system-priority: type: "integer" format: "int32" - description: "See 802.1AX:\r\n Indicating the priority\ - \ associated with the Actors System ID.\r\n range of\ - \ type : 2-octet" + description: "See 802.1AX:\r\n Indicating the priority associated\ + \ with the Actors System ID.\r\n range of type : 2-octet" actor-oper-key: type: "integer" format: "int32" - description: "See 802.1AX:\r\n The current operational\ - \ value of the Key for the Aggregator. The administrative Key value may\ - \ differ from the operational Key value for the reasons discussed in 5.6.2.\r\ - \n The meaning of particular Key values is of local significance.\r\ - \n range of type : 16 bit" - collector-max-delay: - type: "integer" - format: "int32" - description: "See 802.1AX:\r\n The value of this attribute\ - \ defines the maximum delay, in tens of microseconds, that may be imposed\ - \ by the Frame Collector between receiving a frame from an Aggregator Parser,\ - \ and either delivering the frame to its MAC Client or discarding the frame\ - \ (see IEEE 802.1AX clause 5.2.3.1.1).\r\n range of type\ - \ : 16-bit" - is-ssf-reported: - type: "boolean" - description: "This attribute provisions whether the SSF defect should be reported\ - \ as fault cause or not.\r\n It models the ETH-LAG_FT_Sk_MI_SSF_Reported\ - \ defined in G.8021." - default: false + description: "See 802.1AX:\r\n The current operational value\ + \ of the Key for the Aggregator. The administrative Key value may differ\ + \ from the operational Key value for the reasons discussed in 5.6.2.\r\n\ + \ The meaning of particular Key values is of local significance.\r\ + \n range of type : 16 bit" data-rate: type: "integer" format: "int32" - description: "See 802.1AX:\r\n The current data rate, in\ - \ bits per second, of the aggregate link. The value is calculated as N times\ + description: "See 802.1AX:\r\n The current data rate, in bits\ + \ per second, of the aggregate link. The value is calculated as N times\ \ the data rate of a single link in the aggregation, where N is the number\ \ of active links." - traffic-shaping: - description: "none" - $ref: "#/definitions/tapi.eth.TrafficShapingPac" actor-system-id: type: "string" - description: "See 802.1AX:\r\n A MAC address used as a\ - \ unique identifier for the System that contains this Aggregator." - auxiliary-function-position-sequence: - type: "array" - description: "This attribute indicates the positions (i.e., the relative order)\ - \ of all the MEP, MIP, and TCS objects which are associated with the CTP." - items: - type: "integer" - format: "int32" - tapi.eth.EthDmThresholdData: - type: "object" - properties: - bi-dir-dm-clear-threshold: - description: "This attribute contains the bidirectional clear threshold values\ - \ of the delay measurements." - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - near-end-dm-cross-threshold: - description: "This attribute contains the near end cross threshold values\ - \ of the delay measurements." - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - far-end-dm-clear-threshold: - description: "This attribute contains the far end clear threshold values of\ - \ the delay measurements." - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - far-end-dm-cross-threshold: - description: "This attribute contains the far end cross threshold values of\ - \ the delay measurements." - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - bi-dir-dm-cross-threshold: - description: "This attribute contains the bidirectional cross threshold values\ - \ of the delay measurements." - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - near-end-dm-clear-threshold: - description: "This attribute contains the near end clear threshold values\ - \ of the delay measurements." - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + description: "See 802.1AX:\r\n A MAC address used as a unique\ + \ identifier for the System that contains this Aggregator." + partner-system-id: + type: "string" + description: "See 802.1AX:\r\n A MAC address consisting of\ + \ the unique identifier for the current protocol Partner of this Aggregator.\ + \ A value of zero indicates that there is no known Partner. If the aggregation\ + \ is manually configured, this System ID value will be a value assigned\ + \ by the local System." tapi.eth.EthLinkTraceJob: type: "object" properties: @@ -20841,13 +21257,26 @@ definitions: type: "integer" format: "int32" description: "G.8052: This parameter provides the Time To Live (TTL) parameter\ - \ of the Link Track protocol.\r\n The TTL parameter allows\ + \ of the Link Track protocol.\r\n The TTL parameter allows\ \ the receiver (MIP or MEP) of the LTM frame to determine if the frame can\ \ be terminated. TTL is decremented every time the LTM frame is relayed.\ - \ LTM frame with TTL<=1 is terminated and not relayed." - eth-lt-msg: + \ LTM frame with TTL<=1 is terminated and not relayed.\r\n \ + \ IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n An\ + \ initial value for the LTM TTL field." + eth-cfm-link-trace-pac: description: "none" - $ref: "#/definitions/tapi.eth.EthOamOperationCommonPac" + $ref: "#/definitions/tapi.eth.EthCfmLinkTracePac" + destination-address: + type: "string" + description: "G.8052: This parameter provides the destination address, i.e.,\ + \ the MAC Address of the target MEP or MIP." + priority: + type: "integer" + format: "int32" + description: "G.8052: This parameter provides the priority to be used in the\ + \ LBM frame.\r\n G.8052: This parameter provides the priority\ + \ to be used in the TST frame." + default: 7 tapi.eth.EthLinkTraceResultData: type: "object" properties: @@ -20855,45 +21284,15 @@ definitions: type: "array" description: "G.8052: This parameter returns the results of the LT process.\ \ It contains a list of the result received from the individual LTR frames.\r\ - \n The result from the individual LTR frame include the\ - \ Source Mac Address, the TTL, and TLV." + \n The result from the individual LTR frame include the Source\ + \ Mac Address, the TTL, and TLV." items: $ref: "#/definitions/tapi.eth.LinkTraceResult" - tapi.eth.EthLmThresholdData: - type: "object" - properties: - far-end-lm-clear-threshold: - description: "This attribute is only valid for frame loss ratio parameters\ - \ and counter type parameters working in the 'standing condition method'\ - \ (see G.7710, section 10.1.7.2: Threshold reporting) and contains the far\ - \ end clear threshold values of the loss measurements." - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" - far-end-lm-cross-threshold: - description: "This attribute contains the far end cross threshold values of\ - \ the loss measurements." - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" - near-end-lm-clear-threshold: - description: "This attribute is only valid for frame loss ratio parameters\ - \ and counter type parameters working in the 'standing condition method'\ - \ (see G.7710, section 10.1.7.2: Threshold reporting) and contains the near\ - \ end clear threshold values of the loss measurements." - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" - bi-dir-lm-uas-cross-threshold: - type: "integer" - format: "int32" - description: "This attribute contains the bidirectional cross threshold value\ - \ of the UAS loss measurement." - bi-dir-lm-uas-clear-threshold: - type: "integer" - format: "int32" - description: "This attribute is only valid for the UAS parameter working in\ - \ the 'standing condition method' (see G.7710, section 10.1.7.2: Threshold\ - \ reporting) and contains the bidirectional clear threshold value of the\ - \ UAS loss measurement." - near-end-lm-cross-threshold: - description: "This attribute contains the near end cross threshold values\ - \ of the loss measurements." - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" + eth-cfm-link-trace-result-data: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.eth.EthCfmLinkTraceResultData" tapi.eth.EthLoopbackJob: type: "object" properties: @@ -20902,9 +21301,15 @@ definitions: format: "int32" description: "G.8052: This parameter specifies how many LB messages to be\ \ sent for the LB_Series process." - eth-lb-msg: + eth-oam-test-loopback-common-pac: description: "none" - $ref: "#/definitions/tapi.eth.EthOamMsgCommonPac" + $ref: "#/definitions/tapi.eth.EthOamTestLoopbackCommonPac" + lbm-data-tlv: + type: "string" + description: "IEEE P802.1Qcx/D0.3:\r\n String length '1..1480'\r\ + \n The loopback message Data TLV type.\r\n \ + \ MEF 38:\r\n An arbitrary amount of data to be included\ + \ in a Data TLV." tapi.eth.EthLoopbackResultData: type: "object" properties: @@ -20939,34 +21344,160 @@ definitions: format: "int32" description: "G.8052: This parameter returns the total number of received\ \ LBR messages, including the out of order LBR frames." - tapi.eth.EthMegSpec: + tapi.eth.EthMeasurementJobControlCommon: type: "object" properties: - client-mel: + flr-availability-delta-time: type: "integer" format: "int32" - description: "none" - tapi.eth.EthMepCommon: + description: "Time length over which each Availability Frame Loss Ratio value\ + \ is calculated.\r\n MEF 35.1:\r\n [R78]/[CR58]\ + \ [O8] A SOAM PM Implementation MUST support a configurable parameter for\ + \ the length of time over which each Availability flr value is calculated,\ + \ with a range of 1s 300s. This parameter is equivalent to delta-t as\ + \ specified by MEF 10.3.\r\n [R79]/[CR59] [O8] The length\ + \ of time over which each Availability flr value is calculated (delta-t)\ + \ MUST be an integer multiple of the interval between each SLM/1SL frame\ + \ transmission.\r\n [D31]/[CD16] [O8] The default length\ + \ of time over which each Availability flr value is calculated SHOULD be\ + \ 1s." + default: 1 + time-of-the-day-alignment: + type: "boolean" + description: "MEF 35.1:\r\n [D7] A SOAM PM Implementation SHOULD\ + \ allow for no alignment to the time-of-day clock." + default: true + test-identifier: + type: "integer" + format: "int32" + description: "This attribute is used to distinguish each measurement session\ + \ if multiple measurement sessions are simultaneously activated towards\ + \ a peer MEP including concurrent on-demand and proactive tests.\r\n \ + \ It must be unique at least within the context of any measurement\ + \ type for the MEG and initiating MEP.\r\n Note: The attribute\ + \ is not used in case of 2-way loss measurement.\r\n range\ + \ of type : 0..(2^32) - 1" + repetition-period: + description: "This attribute contains the time between the start of two measurement\ + \ intervals. This IS applicable for the repetitive instance type and MAY\ + \ be applicable for the repetitive series type. \r\n Note\ + \ that a value of 0 means not applicable (NA), which is for the cases of\ + \ single instance, single series, or repetitive series without extra gap\ + \ in between the measurement intervals (i.e., also as known as continuous\ + \ series)." + $ref: "#/definitions/tapi.eth.RepetitionPeriod" + offset-from-time-of-the-day: + type: "integer" + format: "int32" + description: "MEF 35.1:\r\n [D8] A SOAM PM Implementation SHOULD\ + \ support a configurable (in minutes) offset from ToD time for alignment\ + \ of the start of Measurement Intervals other than the first Measurement\ + \ Interval." + flr-availability-threshold: + type: "string" + description: "Frame loss ratio threshold to be used in evaluating the Available/Unavailable\ + \ state of each time interval (as specified by Availability Delta Time).\r\ + \n MEF 35.1:\r\n [R81]/[CR61] A SOAM PM Implementation\ + \ MUST support a configurable Availability frame loss ratio threshold to\ + \ be used in evaluating the Available/Unavailable state of each delta-t\ + \ interval per MEF 10.3\r\n [R82]/[CR62] The Availability\ + \ frame loss ratio threshold range of 0.00 through 1.00 MUST be supported\ + \ in increments of 0.01.\r\n [D33]/[CD18] [O8] The default\ + \ Availability frame loss ratio threshold SHOULD be 0.1." + default: "0.1" + priority: + type: "integer" + format: "int32" + description: "This attribute contains the priority value on which the MEP\ + \ performs the measurement.\r\n When the measurement is enabled,\ + \ the MEP should use this value to encode the priority of generated measurement\ + \ frames (OAM PDU frames.).\r\n The EMF usese this value\ + \ to assign the P parameter of the measurement operation." + default: 7 + flr-availability-samples: + type: "integer" + format: "int32" + description: "Number of consecutive Availability Frame Loss Ratio measurements\ + \ to be used to determine Available/Unavailable state transitions.\r\n \ + \ MEF 35.1:\r\n [R80]/[CR60] [O8] The number\ + \ range of 1 through 10 MUST be supported for the configurable number of\ + \ consecutive Availability flr measurements to be used to determine Available/Unavailable\ + \ state transitions.\r\n This parameter is equivalent to\ + \ the Availability parameter of n as specified by MEF 10.3.\r\n \ + \ [D32]/[CD17] [O8] The default number of n for Availability SHOULD\ + \ be 10." + default: 10 + message-period: + type: "integer" + format: "int32" + description: "This attribute indicates the period (frequency) of the measurement\ + \ frame transmission.\r\n Note that the value 0 means that\ + \ only one OAM message per measurement interval is generated.\r\n \ + \ Unit is milliseconds.\r\n range of type : 100ms,\ + \ 1s, 10s" + default: 1000 + measurement-interval: + type: "integer" + format: "int32" + description: "This attribute contains the discrete non overlapping periods\ + \ of time (in seconds) during which measurements are performed\r\n \ + \ (i.e., OAM messages are generated) and reports are gathered\ + \ at the end of the measurement intervals.\r\n Note that\ + \ the value 0 means a degenerated measurement interval with a single OAM\ + \ message and the report is sent as immediately as possible." + tapi.eth.EthMegCommon: type: "object" properties: - lck-period: - description: "This attribute models the MI_LCK_Period signal defined in G.8021\ - \ and configured as specified in G8051. It is the frequency at which the\ - \ LCK messages should be sent.\r\n range of type : 1s,\ - \ 1min" + meg-identifier: + type: "string" + description: "Optional in case 802.1Q maintenanceAssociationName is used." + meg-level: + type: "integer" + format: "int32" + description: "none" + cc-period: + description: "This attribute models the MI_CC_Period signal defined in G.8021\ + \ and configured as specified in G8051. \r\n It is the period\ + \ at which the CCM message should be sent. \r\n Default values\ + \ are: 3.33 ms for PS, 100 ms for PM, 1 s for FM.\r\n ITU-T\ + \ G.8013/Y.1731 (2015)/Amd.1 (11/2018): The ETH-CC transmission period is\ + \ the same for all MEPs in the MEG." $ref: "#/definitions/tapi.eth.OamPeriod" - cc-priority: + client-mel: type: "integer" format: "int32" - description: "This attribute models the MI_CC_Pri signal defined in G.8021\ - \ and configured as specified in G8051. It is the priority at which the\ - \ CCM message should be sent." - default: 7 + description: "none" is-cc-enabled: type: "boolean" description: "This attribute models the MI_CC_Enable signal defined in G.8021\ - \ and configured as specified in G8051." + \ and configured as specified in G8051.\r\n ITU-T G.8013/Y.1731\ + \ (2015)/Amd.1 (11/2018): When ETH-CC transmission is enabled in a MEG,\r\ + \n all MEPs are enabled to periodically transmit frames with\ + \ ETH-CC information to their peer MEPs in the MEG." default: false + tapi.eth.EthMegSpec: + type: "object" + properties: + eth-cfm-maintenance-association: + description: "none" + $ref: "#/definitions/tapi.eth.EthCfmMaintenanceAssociation" + eth-meg-common: + description: "none" + $ref: "#/definitions/tapi.eth.EthMegCommon" + eth-cfm-maintenance-domain: + description: "none" + $ref: "#/definitions/tapi.eth.EthCfmMaintenanceDomain" + tapi.eth.EthMepCommon: + type: "object" + properties: + codirectional: + type: "boolean" + description: "This attribute specifies the directionality of the Ethernet\ + \ MEP with respect to the associated CEP. The value of TRUE means that the\ + \ sink part of the MEP terminates the same signal direction as the sink\ + \ part of the CEP. The Source part behaves similarly. This attribute is\ + \ meaningful only when CEP is bidirectional." + default: true lck-priority: type: "integer" format: "int32" @@ -20974,22 +21505,33 @@ definitions: \ and configured as specified in G8051. It is the priority at which the\ \ LCK messages should be sent." default: 7 - cc-period: - description: "This attribute models the MI_CC_Period signal defined in G.8021\ - \ and configured as specified in G8051. \r\n It is the\ - \ period at which the CCM message should be sent. \r\n \ - \ Default values are: 3.33 ms for PS, 100 ms for PM, 1 s for FM." + mep-identifier: + type: "integer" + format: "int32" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ Integer that is unique among all the MEPs in the same Maintenance\ + \ Association (MEG).\r\n G.8052:\r\n This\ + \ attribute contains the identifier of the MEP." + lck-period: + description: "This attribute models the MI_LCK_Period signal defined in G.8021\ + \ and configured as specified in G8051. It is the frequency at which the\ + \ LCK messages should be sent.\r\n range of type : 1s, 1min" $ref: "#/definitions/tapi.eth.OamPeriod" - mep-mac: - type: "string" - description: "This attribute contains the MAC Address of the MEP." + cc-priority: + type: "integer" + format: "int32" + description: "This attribute models the MI_CC_Pri signal defined in G.8021\ + \ and configured as specified in G8051. It is the priority at which the\ + \ CCM message should be sent." + default: 7 tapi.eth.EthMepSink: type: "object" properties: - dm-1-priority: + peer-mep-identifier: type: "array" - description: "This attribute indicates the list of 1DM priorities for the\ - \ MepSink." + description: "G.8052:\r\n This attribute models the MI_PeerMEP_ID[i]\ + \ signal defined in G.8021 and configured as specified in G.8051. It provides\ + \ the identifiers of the MEPs which are peer to the subject MEP." items: type: "integer" format: "int32" @@ -21026,13 +21568,14 @@ definitions: is-csf-rdi-fdi-enabled: type: "boolean" description: "This attribute models the MI_CSFrdifdiEnable signal defined\ - \ in G.8021 and configured as specified in G8051." + \ in G.8021 and configured as specified in G8051.\r\n aSSFrdi\ + \ ? dCSF-RDI and MI_CSFrdifdiEnable\r\n aSSFfdi ? dCSF-FDI\ + \ and MI_CSFrdifdiEnable" default: true ais-period: description: "This attribute models the MI_AIS_Period signal defined in G.8021\ \ and configured as specified in G8051. It is the frequency at which the\ - \ AIS messages should be sent.\r\n range of type : 1s,\ - \ 1min" + \ AIS messages should be sent.\r\n range of type : 1s, 1min" $ref: "#/definitions/tapi.eth.OamPeriod" ais-priority: type: "integer" @@ -21041,6 +21584,11 @@ definitions: \ and configured as specified in G8051. It is the priority at which the\ \ AIS messages should be sent." default: 7 + unexpected-ltr-received: + type: "integer" + format: "int32" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ The total number of unexpected LTRs received." lm-tf-min: type: "integer" format: "int32" @@ -21053,7 +21601,7 @@ definitions: csf-period: description: "This attribute models the MI_CSF_Period signal defined in G.8021\ \ and configured as specified in G8051. It is the period at which the CSF\ - \ messages should be sent.\r\n range of type : 1s, 1min" + \ messages should be sent.\r\n range of type : 1s, 1min" $ref: "#/definitions/tapi.eth.OamPeriod" csf-priority: type: "integer" @@ -21071,7 +21619,7 @@ definitions: type: "integer" format: "int32" description: "This attribute specifies the priority of the APS messages.\r\ - \n See section 8.1.5 APS insert process in G.8021." + \n See section 8.1.5 APS insert process in G.8021." default: 7 tapi.eth.EthMepSpec: type: "object" @@ -21079,363 +21627,388 @@ definitions: eth-mep-common: description: "none" $ref: "#/definitions/tapi.eth.EthMepCommon" + mep-mac: + type: "string" + description: "This attribute contains the MAC Address of the MEP." + eth-mep-source: + description: "none" + $ref: "#/definitions/tapi.eth.EthMepSource" eth-mep-sink: description: "none" $ref: "#/definitions/tapi.eth.EthMepSink" - eth-mep-source-pac: - description: "none" - $ref: "#/definitions/tapi.eth.EthMepSource" - tapi.eth.EthMipSpec: + tapi.eth.EthMipCommon: type: "object" properties: - mip-mac: - type: "string" - description: "This attribute contains the MAC address of the MIP instance." is-full-mip: type: "boolean" description: "This attribute indicates whether the MIP is a full MIP (true)\ - \ or a down-half MIP (false)." + \ or a down-half MIP (false). Up-half MIP is not foreseen by G.8052" default: false - tapi.eth.EthOamMsgCommonPac: - allOf: - - $ref: "#/definitions/tapi.eth.EthOamOperationCommonPac" - - type: "object" - properties: - data-tlv-length: - type: "integer" - format: "int32" - description: "G.8052: This parameter provides the length (in number of octet)\ - \ of the optional Data TLV to be included in the TST frame." - test-pattern: - type: "integer" - format: "int32" - description: "G.8052: This parameter provides the test pattern to be used\ - \ in the optional Data TLV.\r\n Examples of test patterns\ - \ include pseudo-random bit sequence (PRBS) 2^31-1 as specified in clause\ - \ 5.8 of [ITU-T O.150], all '0' pattern, etc.\r\n The\ - \ following values of pattern types are defined:\r\n \ - \ 0: 'Null signal without CRC-32'\r\n 1: 'Null signal\ - \ with CRC-32'\r\n 2: 'PRBS 2^31-1 without CRC-32'\r\ - \n 3: 'PRBS 2^31-1 with CRC-32'." - period: - description: "G.8052: This parameter provides the periodicity of the TST\ - \ OAM messages." - $ref: "#/definitions/tapi.eth.OamPeriod" - drop-eligibility: - type: "boolean" - description: "G.8052: This parameter provides the eligibility of frames\ - \ with unicast ETH-TST information to be discarded when congestion conditions\ - \ are encountered." - default: false - description: "none" - tapi.eth.EthOamOperationCommonPac: + tapi.eth.EthMipSpec: type: "object" properties: - priority: + eth-mip-common: + description: "none" + $ref: "#/definitions/tapi.eth.EthMipCommon" + mip-mac: + type: "string" + description: "This attribute contains the MAC address of the MIP instance." + tapi.eth.EthOamMepServicePoint: + type: "object" + properties: + eth-mep-common: + description: "none" + $ref: "#/definitions/tapi.eth.EthMepCommon" + eth-mep-source: + description: "none" + $ref: "#/definitions/tapi.eth.EthMepSource" + eth-mep-sink: + description: "none" + $ref: "#/definitions/tapi.eth.EthMepSink" + tapi.eth.EthOamMipServicePoint: + type: "object" + properties: + eth-mip-common: + description: "none" + $ref: "#/definitions/tapi.eth.EthMipCommon" + tapi.eth.EthOamService: + type: "object" + properties: + eth-cfm-maintenance-association: + description: "none" + $ref: "#/definitions/tapi.eth.EthCfmMaintenanceAssociation" + eth-meg-common: + description: "none" + $ref: "#/definitions/tapi.eth.EthMegCommon" + eth-cfm-maintenance-domain: + description: "none" + $ref: "#/definitions/tapi.eth.EthCfmMaintenanceDomain" + tapi.eth.EthOamTestLoopbackCommonPac: + type: "object" + properties: + data-tlv-length: type: "integer" format: "int32" - description: "G.8052: This parameter provides the priority to be used in the\ - \ LBM frame." - default: 7 - destination-address: - type: "string" - description: "G.8052: This parameter provides the destination address, i.e.,\ - \ the MAC Address of the target MEP or MIP." + description: "G.8052: This parameter provides the length (in number of octet)\ + \ of the optional Data TLV to be included in the TST frame." + period: + description: "G.8052: This parameter provides the periodicity of the TST OAM\ + \ messages.\r\n G.8052: This parameter provides the periodicity\ + \ of the LBM OAM messages used in the LB Series process." + $ref: "#/definitions/tapi.eth.OamPeriod" + drop-eligibility: + type: "boolean" + description: "G.8052: This parameter provides the eligibility of frames with\ + \ unicast ETH-TST information to be discarded when congestion conditions\ + \ are encountered.\r\n G.8052: This parameter provides the\ + \ eligibility of frames with unicast ETH-LB information to be discarded\ + \ when congestion conditions are encountered." + default: false tapi.eth.EthOnDemand1DmPerformanceData: type: "object" properties: - on-demand-near-end-1-dm-parameters: + samples-near-end-1-dm-parameters: description: "This attribute contains the results of an on-demand frame delay\ \ measurement job in the ingress direction." - $ref: "#/definitions/tapi.eth.OnDemandDmPerformanceParameters" + $ref: "#/definitions/tapi.eth.SamplesDmPerformanceParameters" + statistical-near-end-1-dm-parameters: + description: "This attribute contains the statistical near end performnace\ + \ parameters." + $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + tapi.eth.EthOnDemand1DmSourcePerformanceData: + type: "object" tapi.eth.EthOnDemand1LmPerformanceData: type: "object" properties: - on-demand-near-end-1-lm-parameters: + statistical-near-end-1-lm-parameters: + description: "This attribute contains the statistical near end performnace\ + \ parameters." + $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" + total-counters-near-end-1-lm-parameters: description: "This attribute contains the results of an on-demand synthetic\ \ loss measurement job in the ingress direction." - $ref: "#/definitions/tapi.eth.OnDemandLmPerformanceParameters" - tapi.eth.EthOnDemand1wayMeasurementJob: + $ref: "#/definitions/tapi.eth.TotalCountersLmPerformanceParameters" + tapi.eth.EthOnDemand1LmSourcePerformanceData: + type: "object" + tapi.eth.EthOnDemandDmPerformanceData: type: "object" properties: - on-demand-control-1way-source: - description: "none" - $ref: "#/definitions/tapi.eth.EthOnDemandMeasurementJobControlSource" - on-demand-control-1way-sink: - description: "none" - $ref: "#/definitions/tapi.eth.EthOnDemandMeasurementJobControlSink" - tapi.eth.EthOnDemand2wayMeasurementJob: + statistical-bi-dir-dm-parameters: + description: "This attribute contains the statistical bidirectional performnace\ + \ parameters." + $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + samples-far-end-dm-parameters: + description: "This attribute contains the results of an on-demand frame delay\ + \ measurement job in the ingress direction." + $ref: "#/definitions/tapi.eth.SamplesDmPerformanceParameters" + statistical-far-end-dm-parameters: + description: "This attribute contains the statistical far end performnace\ + \ parameters." + $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + statistical-near-end-dm-parameters: + description: "This attribute contains the statistical near end performnace\ + \ parameters." + $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + samples-near-end-dm-parameters: + description: "This attribute contains the results of an on-demand frame delay\ + \ measurement job in the ingress direction." + $ref: "#/definitions/tapi.eth.SamplesDmPerformanceParameters" + tapi.eth.EthOnDemandDualEndedMeasurementJob: type: "object" properties: - on-demand-control-2way-source: + eth-on-demand-measurement-job-control-sink: + description: "none" + $ref: "#/definitions/tapi.eth.EthOnDemandMeasurementJobControlSink" + eth-on-demand-measurement-job-control-source: description: "none" $ref: "#/definitions/tapi.eth.EthOnDemandMeasurementJobControlSource" - tapi.eth.EthOnDemandDmPerformanceData: - type: "object" - properties: - on-demand-far-end-dm-parameters: - description: "This attribute contains the results of an on-demand frame delay\ - \ measurement job in the ingress direction." - $ref: "#/definitions/tapi.eth.OnDemandDmPerformanceParameters" - on-demand-near-end-dm-parameters: - description: "This attribute contains the results of an on-demand frame delay\ - \ measurement job in the ingress direction." - $ref: "#/definitions/tapi.eth.OnDemandDmPerformanceParameters" tapi.eth.EthOnDemandLmPerformanceData: type: "object" properties: - on-demand-far-end-lm-parameters: - description: "This attribute contains the results of an on-demand synthetic\ - \ loss measurement job in the egress direction." - $ref: "#/definitions/tapi.eth.OnDemandLmPerformanceParameters" - on-demand-near-end-lm-parameters: + bidir-unavailable-intervals: + type: "integer" + format: "int32" + description: "A generalized (bidirectional) UAS.\r\n MEF 35.1:\ + \ A 32-bit counter reflecting the number of delta-t intervals evaluated\ + \ as Unavailable (i.e., for which A(delta-t) = 0).\r\ + \n " + statistical-far-end-lm-parameters: + description: "This attribute contains the statistical far end performnace\ + \ parameters." + $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" + statistical-near-end-lm-parameters: + description: "This attribute contains the statistical near end performnace\ + \ parameters." + $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" + total-counters-near-end-lm-parameters: description: "This attribute contains the results of an on-demand synthetic\ \ loss measurement job in the ingress direction." - $ref: "#/definitions/tapi.eth.OnDemandLmPerformanceParameters" + $ref: "#/definitions/tapi.eth.TotalCountersLmPerformanceParameters" + total-counters-far-end-lm-parameters: + description: "This attribute contains the results of an on-demand synthetic\ + \ loss measurement job in the egress direction." + $ref: "#/definitions/tapi.eth.TotalCountersLmPerformanceParameters" tapi.eth.EthOnDemandMeasurementJobControlSink: - type: "object" - properties: - priority: - type: "integer" - format: "int32" - description: "This attribute contains the priority of the OAM PDU frames.\r\ - \n range of type : 0, 1, 2, 3, 4, 5, 6, 7" - default: 7 - responder-mep-id: - type: "string" - description: "none" - source-address: - type: "string" - description: "This attribute contains the MAC address of the peer MEP. See\ - \ G.8013 for details." - test-identifier: - type: "integer" - format: "int32" - description: "This attribute is used to distinguish each measurement session\ - \ if multiple measurement sessions are simultaneously activated towards\ - \ a peer MEP including concurrent on-demand and proactive tests. It must\ - \ be unique at least within the context of any measurement type for the\ - \ MEG and initiating MEP.\r\n range of type : 0..(2^32)\ - \ - 1" + allOf: + - $ref: "#/definitions/tapi.eth.EthMeasurementJobControlCommon" + - type: "object" + properties: + sink-mep-id: + type: "integer" + format: "int32" + description: "none" + source-address: + type: "string" + description: "This attribute contains the MAC address of the peer MEP. See\ + \ G.8013 for details." + description: "This object class represents an on-demand measurement job controller\ + \ sink for 1-way measurements. It is created as a result of an establishOnDemandDualEndedMeasurementJobSink()\ + \ operation. It is deleted either automatically after the measurement job\ + \ has completed (stop time reached) and the performance data AVC notification\ + \ has been sent, or by an explicit abortOnDemandMeasurementJob() operation\ + \ when the measurement job is running." tapi.eth.EthOnDemandMeasurementJobControlSource: + allOf: + - $ref: "#/definitions/tapi.eth.EthMeasurementJobControlCommon" + - type: "object" + properties: + data-tlv-length: + type: "integer" + format: "int32" + description: "This parameter provides the size of the optional data TLV.\r\ + \n Non-negative integer represents the number of bytes\ + \ for the length of the padding TLV.\r\n Notes:\r\n \ + \ When configuring this parameter one should be aware of the\ + \ maximum allowed total frame size limitation.\r\n The\ + \ attribute is not used in case of 2-way loss measurement.\r\n \ + \ range of type : Depends on the allowed MTU size." + destination-address: + type: "string" + description: "This attribute contains the MAC address of the peer MEP. See\ + \ G.8013 for details." + oam-pdu-generation-type: + description: "This attribute contains the pattern that is used for the generation\ + \ of OAM PDUs." + $ref: "#/definitions/tapi.eth.OamPduGenerationType" + controller-mep-id: + type: "integer" + format: "int32" + description: "none" + description: "Basic attributes: destinationAddress, priority\r\n \ + \ Measurement configuration related attributes: oamPduGenerationType, startTime,\ + \ stopTime, messagePeriod, repetitionPeriod, measurementInterval\r\n \ + \ Optional attributes: dataTlvLength, testIdentifier\r\n \ + \ This object class represents an on-demand measurement job controller source\ + \ for 1-way measurements. It is created as a result of an establishOnDemandDualEndedMeasurementJobSource()\ + \ operation. It is deleted either automatically after the measurement job\ + \ has completed (stop time reached), or by an explicit abortOnDemandMeasurementJob()\ + \ operation while the measurement job is running." + tapi.eth.EthOnDemandSingleEndedMeasurementJob: type: "object" properties: - data-tlv-length: - type: "integer" - format: "int32" - description: "This parameter provides the size of the optional data TLV.\r\ - \n Non-negative integer represents the number of bytes\ - \ for the length of the padding TLV.\r\n Notes:\r\n \ - \ When configuring this parameter one should be aware\ - \ of the maximum allowed total frame size limitation.\r\n \ - \ The attribute is not used in case of 2-way loss measurement.\r\n\ - \ range of type : Depends on the allowed MTU size." - test-identifier: - type: "integer" - format: "int32" - description: "This attribute is used to distinguish each measurement session\ - \ if multiple measurement sessions are simultaneously activated towards\ - \ a peer MEP including concurrent on-demand and proactive tests. It must\ - \ be unique at least within the context of any measurement type for the\ - \ MEG and initiating MEP.\r\n Note: The attribute is\ - \ not used in case of LMM/LMR measurement.\r\n range\ - \ of type : 0..(2^32) - 1" - repetition-period: - description: "This attribute contains the time between the start of two measurement\ - \ intervals. This IS applicable for the repetitive instance type and MAY\ - \ be applicable for the repetitive series type. \r\n \ - \ Note that a value of 0 means not applicable (NA), which is for the cases\ - \ of single instance, single series, or repetitive series without extra\ - \ gap in between the measurement intervals (i.e., also as known as continuous\ - \ series)." - $ref: "#/definitions/tapi.eth.RepetitionPeriod" - destination-address: - type: "string" - description: "This attribute contains the MAC address of the peer MEP. See\ - \ G.8013 for details." - oam-pdu-generation-type: - description: "This attribute contains the pattern that is used for the generation\ - \ of OAM PDUs." - $ref: "#/definitions/tapi.eth.OamPduGenerationType" - priority: - type: "integer" - format: "int32" - description: "This attribute contains the priority of the OAM PDU frames.\r\ - \n range of type : 0, 1, 2, 3, 4, 5, 6, 7" - default: 7 - message-period: - description: "This attribute contains the frequency of the OAM message (PDU)\ - \ generation within a series. \r\n Note that the value\ - \ 0 means that only one OAM message per measurement interval is generated.\r\ - \n range of type : See corresponding Enum." - $ref: "#/definitions/tapi.eth.MessagePeriod" - controller-mep-id: - type: "string" + eth-on-demand-measurement-job-control-source: description: "none" - measurement-interval: - type: "integer" - format: "int32" - description: "This attribute contains the discrete non overlapping periods\ - \ of time (in seconds) during which measurements are performed (i.e., OAM\ - \ messages are generated) and reports are gathered at the end of the measurement\ - \ intervals. Note that the value 0 means a degenerated measurement interval\ - \ with a single OAM message and the report is sent as immediately as possible.\r\ - \n range of type : Non-negative" + $ref: "#/definitions/tapi.eth.EthOnDemandMeasurementJobControlSource" tapi.eth.EthProActive1DmPerformanceData: type: "object" properties: - pro-active-near-end-1-dm-parameters: + statistical-near-end-1-dm-parameters: description: "This attribute contains the statistical near end performnace\ \ parameters." $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + tapi.eth.EthProActive1DmSourcePerformanceData: + type: "object" tapi.eth.EthProActive1LmPerformanceData: type: "object" properties: - pro-active-near-end-1-lm-parameters: + statistical-near-end-1-lm-parameters: description: "This attribute contains the statistical near end performnace\ \ parameters." $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" - tapi.eth.EthProActive1wayMeasurementJob: - type: "object" - properties: - pro-active-control-1way-source: - description: "none" - $ref: "#/definitions/tapi.eth.EthProActiveMeasurementJobControlSource" - pro-active-control-1way-sink: - description: "none" - $ref: "#/definitions/tapi.eth.EthProActiveMeasurementJobControlSink" - tapi.eth.EthProActive2wayMeasurementJob: + total-counters-near-end-1-lm-parameters: + description: "This attribute contains the results of an on-demand synthetic\ + \ loss measurement job in the ingress direction." + $ref: "#/definitions/tapi.eth.TotalCountersLmPerformanceParameters" + tapi.eth.EthProActive1LmSourcePerformanceData: type: "object" - properties: - pro-active-control-2way-source: - description: "none" - $ref: "#/definitions/tapi.eth.EthProActiveMeasurementJobControlSource" tapi.eth.EthProActiveDmPerformanceData: type: "object" properties: - pro-active-bi-dir-dm-parameters: + statistical-bi-dir-dm-parameters: description: "This attribute contains the statistical bidirectional performnace\ \ parameters." $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - pro-active-far-end-dm-parameters: + statistical-far-end-dm-parameters: description: "This attribute contains the statistical far end performnace\ \ parameters." $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - pro-active-near-end-dm-parameters: + statistical-near-end-dm-parameters: description: "This attribute contains the statistical near end performnace\ \ parameters." $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + tapi.eth.EthProActiveDualEndedMeasurementJob: + type: "object" + properties: + eth-pro-active-measurement-job-control-source: + description: "none" + $ref: "#/definitions/tapi.eth.EthProActiveMeasurementJobControlSource" + eth-pro-active-measurement-job-control-sink: + description: "none" + $ref: "#/definitions/tapi.eth.EthProActiveMeasurementJobControlSink" tapi.eth.EthProActiveLmPerformanceData: type: "object" properties: - bidirectional-uas: + bidir-unavailable-intervals: type: "integer" format: "int32" - description: "This attribute contains the bidirectional UAS (unavailable seconds)\ - \ detected in the monitoring interval.\r\n range of type\ - \ : 0..900 for 15min interval or 0..86400 for 24 hr interval." - pro-active-far-end-lm-parameters: + description: "A generalized (bidirectional) UAS.\r\n MEF 35.1:\ + \ A 32-bit counter reflecting the number of delta-t intervals evaluated\ + \ as Unavailable (i.e., for which A(delta-t) = 0).\r\ + \n " + statistical-far-end-lm-parameters: description: "This attribute contains the statistical far end performnace\ \ parameters." $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" - pro-active-near-end-lm-parameters: + statistical-near-end-lm-parameters: description: "This attribute contains the statistical near end performnace\ \ parameters." $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" + total-counters-near-end-lm-parameters: + description: "This attribute contains the results of an on-demand synthetic\ + \ loss measurement job in the ingress direction." + $ref: "#/definitions/tapi.eth.TotalCountersLmPerformanceParameters" + total-counters-far-end-lm-parameters: + description: "This attribute contains the results of an on-demand synthetic\ + \ loss measurement job in the egress direction." + $ref: "#/definitions/tapi.eth.TotalCountersLmPerformanceParameters" tapi.eth.EthProActiveMeasurementJobControlSink: + allOf: + - $ref: "#/definitions/tapi.eth.EthMeasurementJobControlCommon" + - type: "object" + properties: + sink-mep-id: + type: "integer" + format: "int32" + description: "none" + source-address: + type: "string" + description: "This attribute contains the MAC address of the peer MEP. See\ + \ G.8013 for details." + is-enabled: + type: "boolean" + description: "This attribute identifies the state of the measurement job.\ + \ If set to TRUE, the MEP performs proactive Performance Measurement." + default: true + description: "This object class allows the control of the proactive 1-way measurement.\ + \ It is created as a part of an establishProActiveDualEndedMeasurementJobSink()\ + \ operation. Lifecycle: A pre-condition of deleting the object is that the\ + \ Enable attribute should have the value FALSE." + tapi.eth.EthProActiveMeasurementJobControlSource: + allOf: + - $ref: "#/definitions/tapi.eth.EthMeasurementJobControlCommon" + - type: "object" + properties: + data-tlv-length: + type: "integer" + format: "int32" + description: "This parameter provides the size of the optional data TLV.\r\ + \n Non-negative integer represents the number of bytes\ + \ for the length of the padding TLV.\r\n Notes:\r\n \ + \ When configuring this parameter one should be aware of the\ + \ maximum allowed total frame size limitation.\r\n The\ + \ attribute is not used in case of 2-way loss measurement.\r\n \ + \ range of type : Depends on the allowed MTU size." + destination-address: + type: "string" + description: "This attribute provides the Unicast MAC address of the intented\ + \ destination." + controller-mep-id: + type: "integer" + format: "int32" + description: "none" + is-enabled: + type: "boolean" + description: "This attribute identifies the state of the measurement job.\ + \ If set to TRUE, the MEP performs proactive Performance Measurement." + default: true + description: "This object class represents a proactive measurement job controller\ + \ source for 1way measurements. It is created as a part of an establishProactiveDualEndedMeasurementJobSource()\ + \ operation." + tapi.eth.EthProActiveSingleEndedMeasurementJob: type: "object" properties: - responder-mep-id: - type: "string" + eth-pro-active-measurement-job-control-source: description: "none" - source-address: - type: "string" - description: "This attribute contains the MAC address of the peer MEP. See\ - \ G.8013 for details." - test-identifier: - type: "integer" - format: "int32" - description: "This attribute is used to distinguish each measurement session\ - \ if multiple measurement sessions are simultaneously activated towards\ - \ a peer MEP including concurrent on-demand and proactive tests. It must\ - \ be unique at least within the context of any measurement type for the\ - \ MEG and initiating MEP.\r\n range of type : 0..(2^32)\ - \ - 1" - is-enabled: - type: "boolean" - description: "This attribute identifies the state of the measurement job.\ - \ If set to TRUE, the MEP performs proactive Performance Measurement." - default: true - tapi.eth.EthProActiveMeasurementJobControlSource: + $ref: "#/definitions/tapi.eth.EthProActiveMeasurementJobControlSource" + tapi.eth.EthServiceIntefacePointSpec: type: "object" properties: - data-tlv-length: - type: "integer" - format: "int32" - description: "This parameter provides the size of the optional data TLV.\r\ - \n Non-negative integer represents the number of bytes\ - \ for the length of the padding TLV.\r\n Notes:\r\n \ - \ When configuring this parameter one should be aware\ - \ of the maximum allowed total frame size limitation.\r\n \ - \ The attribute is not used in case of 2-way loss measurement.\r\n\ - \ range of type : Depends on the allowed MTU size." - period: - description: "This attribute indicates the period (frequency) of the measurement\ - \ frame transmission.\r\n range of type : 100ms, 1s,\ - \ 10s" - $ref: "#/definitions/tapi.eth.OamPeriod" - test-identifier: - type: "integer" - format: "int32" - description: "This attribute is used to distinguish each measurement session\ - \ if multiple measurement sessions are simultaneously activated towards\ - \ a peer MEP including concurrent on-demand and proactive tests. It must\ - \ be unique at least within the context of any measurement type for the\ - \ MEG and initiating MEP.\r\n Note: The attribute is\ - \ not used in case of 2-way loss measurement. \r\n range\ - \ of type : 0..(2^32) - 1" - destination-address: - type: "string" - description: "This attribute provides the Unicast MAC address of the intented\ - \ destination." - priority: - type: "integer" - format: "int32" - description: "This attribute contains the priority value on which the MEP\ - \ performs the measurement. When the measurement is enabled, the MEP should\ - \ use this value to encode the priority of generated measurement frames.\ - \ The EMF usese this value to assign the P parameter of the measurement\ - \ operation." - default: 7 - controller-mep-id: - type: "string" - description: "none" - is-enabled: - type: "boolean" - description: "This attribute identifies the state of the measurement job.\ - \ If set to TRUE, the MEP performs proactive Performance Measurement." - default: true - tapi.eth.EthTerminationPac: + phy-type: + description: "This attribute identifies the PHY type of the ETY trail termination.\ + \ See IEEE 802.3 clause 30.3.2.1.2." + $ref: "#/definitions/tapi.eth.EtyPhyType" + phy-type-list: + type: "array" + description: "This attribute identifies the possible PHY types that could\ + \ be supported at the ETY trail termination. See IEEE 802.3 clause 30.3.2.1.3." + items: + $ref: "#/definitions/tapi.eth.EtyPhyType" + tapi.eth.EthTerminationCommonPac: type: "object" properties: filter-config-1: type: "array" description: "This attribute models the ETHx/ETH-m_A_Sk_MI_Filter_Config information\ - \ defined in G.8021.\r\n It indicates the configured\ - \ filter action for each of the 33 group MAC addresses for control frames.\r\ - \n The 33 MAC addresses are:\r\n 01-80-C2-00-00-10,\ - \ \r\n 01-80-C2-00-00-00 to 01-80-C2-00-00-0F, and \r\ - \n 01-80-C2-00-00-20 to 01-80-C2-00-00-2F.\r\n \ - \ The filter action is Pass or Block. \r\n \ - \ If the destination address of the incoming ETH_CI_D matches one of\ - \ the above addresses, the filter process shall perform the corresponding\ - \ configured filter action. \r\n If none of the above\ - \ addresses match, the ETH_CI_D is passed.\r\n range\ - \ of type : MacAddress: \r\n 01-80-C2-00-00-10, \r\n\ - \ 01-80-C2-00-00-00 to \r\n 01-80-C2-00-00-0F,\ - \ and \r\n 01-80-C2-00-00-20 to \r\n \ - \ 01-80-C2-00-00-2F;\r\n ActionEnum:\r\n \ - \ PASS, BLOCK" + \ defined in G.8021.\r\n It indicates the configured filter\ + \ action for each of the 33 group MAC addresses for control frames.\r\n\ + \ The 33 MAC addresses are:\r\n 01-80-C2-00-00-10,\ + \ \r\n 01-80-C2-00-00-00 to 01-80-C2-00-00-0F, and \r\n \ + \ 01-80-C2-00-00-20 to 01-80-C2-00-00-2F.\r\n \ + \ The filter action is Pass or Block. \r\n If the destination\ + \ address of the incoming ETH_CI_D matches one of the above addresses, the\ + \ filter process shall perform the corresponding configured filter action.\ + \ \r\n If none of the above addresses match, the ETH_CI_D\ + \ is passed.\r\n " items: type: "string" ether-type: @@ -21444,12 +22017,11 @@ definitions: $ref: "#/definitions/tapi.eth.VlanType" priority-code-point-config: description: "This attribute models the ETHx/ETH-m _A_Sk_MI_PCP_Config information\ - \ defined in G.8021.\r\n range of type : see Enumeration" + \ defined in G.8021." $ref: "#/definitions/tapi.eth.PcpCoding" frametype-config: description: "This attribute models the ETHx/ETH-m_A_Sk_MI_Frametype_Config\ - \ information defined in G.8021.\r\n range of type :\ - \ see Enumeration" + \ information defined in G.8021." $ref: "#/definitions/tapi.eth.FrameType" port-vid: type: "string" @@ -21460,12 +22032,41 @@ definitions: description: "This attribute models the ETHx/ETH-m _A_Sk_MI_P_Regenerate information\ \ defined in G.8021." $ref: "#/definitions/tapi.eth.PriorityMapping" + tapi.eth.EthTerminationPac: + type: "object" + properties: + eth-termination-common-pac: + description: "none" + $ref: "#/definitions/tapi.eth.EthTerminationCommonPac" tapi.eth.EthTestJob: type: "object" properties: - eth-test-msg: + number: + type: "integer" + format: "int32" + description: "This parameter specifies how many TST messages to be sent." + destination-address: + type: "string" + description: "G.8052: This parameter provides the destination address, i.e.,\ + \ the MAC Address of the target MEP or MIP." + test-pattern: + type: "string" + description: "G.8052: This parameter provides the test pattern to be used\ + \ in the optional Data TLV.\r\n Examples of test patterns\ + \ include pseudo-random bit sequence (PRBS) 2^31-1 as specified in clause\ + \ 5.8 of [ITU-T O.150], all '0' pattern, etc." + eth-test-job-sink-point: description: "none" - $ref: "#/definitions/tapi.eth.EthOamMsgCommonPac" + $ref: "#/definitions/tapi.eth.EthTestJobSinkPoint" + eth-oam-test-loopback-common-pac: + description: "none" + $ref: "#/definitions/tapi.eth.EthOamTestLoopbackCommonPac" + tapi.eth.EthTestJobSinkPoint: + type: "object" + properties: + source-address: + type: "string" + description: "This attribute contains the MAC address of the peer MEP." tapi.eth.EthTestResultData: type: "object" properties: @@ -21473,7 +22074,24 @@ definitions: type: "integer" format: "int32" description: "G.8052: This parameter returns the total number of sent TST\ - \ frames." + \ frames.\r\n Optional in case of sink only MEP." + rec-tst-frames: + type: "integer" + format: "int32" + description: "Received TST frames. Optional in case of source only MEP." + tapi.eth.EtyPac: + type: "object" + properties: + phy-type: + description: "This attribute identifies the PHY type of the ETY trail termination.\ + \ See IEEE 802.3 clause 30.3.2.1.2." + $ref: "#/definitions/tapi.eth.EtyPhyType" + phy-type-list: + type: "array" + description: "This attribute identifies the possible PHY types that could\ + \ be supported at the ETY trail termination. See IEEE 802.3 clause 30.3.2.1.3." + items: + $ref: "#/definitions/tapi.eth.EtyPhyType" tapi.eth.EtyPhyType: type: "string" enum: @@ -21491,13 +22109,9 @@ definitions: - "10GBASE-X" - "10GBASE_R" - "10GBASE_W" - tapi.eth.EtyTerminationPac: + tapi.eth.EtyTerminationCommonPac: type: "object" properties: - phy-type: - description: "This attribute identifies the PHY type of the ETY trail termination.\ - \ See IEEE 802.3 clause 30.3.2.1.2." - $ref: "#/definitions/tapi.eth.EtyPhyType" is-fts-enabled: type: "boolean" description: "This attribute indicates whether Forced Transmitter Shutdown\ @@ -21508,406 +22122,475 @@ definitions: description: "This attribute identifies whether the Transmit Pause process\ \ is enabled or not. It models the MI_TxPauseEnable defined in G.8021." default: false - phy-type-list: - type: "array" - description: "This attribute identifies the possible PHY types that could\ - \ be supported at the ETY trail termination. See IEEE 802.3 clause 30.3.2.1.3." - items: - $ref: "#/definitions/tapi.eth.EtyPhyType" + tapi.eth.EtyTerminationPac: + allOf: + - $ref: "#/definitions/tapi.eth.EtyPac" + - type: "object" + properties: + ety-termination-common-pac: + description: "none" + $ref: "#/definitions/tapi.eth.EtyTerminationCommonPac" + description: "none" tapi.eth.FrameType: type: "string" enum: - "ADMIT_ONLY_VLAN_TAGGED_FRAMES" - "ADMIT_ONLY_UNTAGGED_AND_PRIORITY_TAGGED_FRAMES" - "ADMIT_ALL_FRAMES" - tapi.eth.LinkTraceResult: - type: "object" - properties: - data-tlv-length: - type: "integer" - format: "int32" - description: "G.8052: This attribute contains the length (in number of octets)\ - \ of the Data TLV of an individual LTR frame result." - time-to-live: - type: "integer" - format: "int32" - description: "G.8052: This attribute contains the Time To Live (TTL) value\ - \ of an individual LTR frame result." - source-address: - type: "string" - description: "G.8052: This attribute contains the source MAC Address of an\ - \ individual LTR frame result." - tapi.eth.MegAugmentation1: + tapi.eth.HistoryDataAugmentation1: type: "object" properties: - eth-meg-spec: + eth-on-demand-1-dm-performance-data: description: "none" - $ref: "#/definitions/tapi.eth.EthMegSpec" + $ref: "#/definitions/tapi.eth.EthOnDemand1DmPerformanceData" x-augmentation: prefix: "tapi-eth" namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.MepAugmentation1: + tapi.eth.HistoryDataAugmentation10: type: "object" properties: - eth-mep-spec: + eth-pro-active-1-dm-source-performance-data: description: "none" - $ref: "#/definitions/tapi.eth.EthMepSpec" + $ref: "#/definitions/tapi.eth.EthProActive1DmSourcePerformanceData" x-augmentation: prefix: "tapi-eth" namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.MessagePeriod: - type: "string" - enum: - - "10MS" - - "100MS" - - "1S" - - "10S" - - "0" - tapi.eth.MipAugmentation1: + tapi.eth.HistoryDataAugmentation11: type: "object" properties: - eth-mip-spec: + eth-on-demand-dm-performance-data: description: "none" - $ref: "#/definitions/tapi.eth.EthMipSpec" + $ref: "#/definitions/tapi.eth.EthOnDemandDmPerformanceData" x-augmentation: prefix: "tapi-eth" namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.OamJobAugmentation1: + tapi.eth.HistoryDataAugmentation12: type: "object" properties: - eth-loopback-job: + eth-pro-active-lm-performance-data: description: "none" - $ref: "#/definitions/tapi.eth.EthLoopbackJob" + $ref: "#/definitions/tapi.eth.EthProActiveLmPerformanceData" x-augmentation: prefix: "tapi-eth" namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.OamJobAugmentation2: + tapi.eth.HistoryDataAugmentation2: type: "object" properties: - eth-on-demand-2way-measurement-job: + eth-on-demand-1-dm-source-performance-data: description: "none" - $ref: "#/definitions/tapi.eth.EthOnDemand2wayMeasurementJob" + $ref: "#/definitions/tapi.eth.EthOnDemand1DmSourcePerformanceData" x-augmentation: prefix: "tapi-eth" namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.OamJobAugmentation3: + tapi.eth.HistoryDataAugmentation3: type: "object" properties: - eth-on-demand-1way-measurement-job: + eth-on-demand-1-lm-performance-data: description: "none" - $ref: "#/definitions/tapi.eth.EthOnDemand1wayMeasurementJob" + $ref: "#/definitions/tapi.eth.EthOnDemand1LmPerformanceData" x-augmentation: prefix: "tapi-eth" namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.OamJobAugmentation4: + tapi.eth.HistoryDataAugmentation4: type: "object" properties: - eth-pro-active-2way-measurement-job: + eth-pro-active-1-lm-performance-data: description: "none" - $ref: "#/definitions/tapi.eth.EthProActive2wayMeasurementJob" + $ref: "#/definitions/tapi.eth.EthProActive1LmPerformanceData" x-augmentation: prefix: "tapi-eth" namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.OamJobAugmentation5: + tapi.eth.HistoryDataAugmentation5: type: "object" properties: - eth-pro-active-1way-measurement-job: + eth-pro-active-dm-performance-data: description: "none" - $ref: "#/definitions/tapi.eth.EthProActive1wayMeasurementJob" + $ref: "#/definitions/tapi.eth.EthProActiveDmPerformanceData" x-augmentation: prefix: "tapi-eth" namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.OamJobAugmentation6: + tapi.eth.HistoryDataAugmentation6: type: "object" properties: - eth-link-trace-job: + eth-pro-active-1-lm-source-performance-data: description: "none" - $ref: "#/definitions/tapi.eth.EthLinkTraceJob" + $ref: "#/definitions/tapi.eth.EthProActive1LmSourcePerformanceData" x-augmentation: prefix: "tapi-eth" namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.OamJobAugmentation7: + tapi.eth.HistoryDataAugmentation7: type: "object" properties: - eth-test-job: + eth-on-demand-lm-performance-data: description: "none" - $ref: "#/definitions/tapi.eth.EthTestJob" + $ref: "#/definitions/tapi.eth.EthOnDemandLmPerformanceData" x-augmentation: prefix: "tapi-eth" namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.OamPduGenerationType: - type: "string" - enum: - - "SINGLE_INSTANCE" - - "REPETITIVE_INSTANCE" - - "SINGLE_SERIES" - - "REPETITIVE_SERIES" - tapi.eth.OamPeriod: - type: "string" - enum: - - "3_33MS" - - "10MS" - - "100MS" - - "1S" - - "10S" - - "1MIN" - - "10MIN" - tapi.eth.OnDemandDmPerformanceParameters: - type: "object" - properties: - frame-delay-variation-list: - type: "array" - description: "This attribute contains the frame delay variations measured\ - \ in ns (nano second). The multiplicity is defined by (numberOfSamples\ - \ - 1, for numberOfSamples > 0)." - items: - type: "integer" - format: "int32" - number-of-samples: - type: "integer" - format: "int32" - description: "This attribute contains the number of received DM frames (successful\ - \ samples) used for this frame delay measurement.\r\n \ - \ range of type : non-negative" - frame-delay-list: - type: "array" - description: "This attribute contains the frame delays measured in ns (nano\ - \ second, 1x10e-9 seconds). The multiplicity is defined by the numberOfSamples\ - \ attribute." - items: - type: "integer" - format: "int32" - tapi.eth.OnDemandLmPerformanceParameters: - type: "object" - properties: - total-transmitted-frames: - type: "integer" - format: "int32" - description: "This attribute contains the total number of frames transmitted." - total-frame-loss-ratio: - type: "string" - description: "This attribute contains the frame loss ratio (number of lost\ - \ frames divided by the number of total frames (N_LF / N_TF)).\r\n \ - \ The accuracy of the value is for further study." - total-lost-frames: - type: "integer" - format: "int32" - description: "This attribute contains the total number of frames lost." - tapi.eth.PcpCoding: - type: "string" - enum: - - "8P0D" - - "7P1D" - - "6P2D" - - "5P3D" - - "DEI" - tapi.eth.PmCurrentDataAugmentation1: + tapi.eth.HistoryDataAugmentation8: type: "object" properties: - eth-loopback-result-data: + eth-on-demand-1-lm-source-performance-data: description: "none" - $ref: "#/definitions/tapi.eth.EthLoopbackResultData" + $ref: "#/definitions/tapi.eth.EthOnDemand1LmSourcePerformanceData" x-augmentation: prefix: "tapi-eth" namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.PmCurrentDataAugmentation10: + tapi.eth.HistoryDataAugmentation9: type: "object" properties: - eth-on-demand-dm-performance-data: + eth-pro-active-1-dm-performance-data: description: "none" - $ref: "#/definitions/tapi.eth.EthOnDemandDmPerformanceData" + $ref: "#/definitions/tapi.eth.EthProActive1DmPerformanceData" x-augmentation: prefix: "tapi-eth" namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.PmCurrentDataAugmentation11: + tapi.eth.InputAugmentation1: type: "object" properties: - eth-pro-active-1-dm-performance-data: + eth-link-trace-job: description: "none" - $ref: "#/definitions/tapi.eth.EthProActive1DmPerformanceData" + $ref: "#/definitions/tapi.eth.EthLinkTraceJob" x-augmentation: prefix: "tapi-eth" namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.PmCurrentDataAugmentation2: + tapi.eth.InputAugmentation2: type: "object" properties: - eth-link-trace-result-data: + eth-loopback-job: description: "none" - $ref: "#/definitions/tapi.eth.EthLinkTraceResultData" + $ref: "#/definitions/tapi.eth.EthLoopbackJob" x-augmentation: prefix: "tapi-eth" namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.PmCurrentDataAugmentation3: + tapi.eth.InputAugmentation3: type: "object" properties: - eth-test-result-data: + eth-test-job: description: "none" - $ref: "#/definitions/tapi.eth.EthTestResultData" + $ref: "#/definitions/tapi.eth.EthTestJob" x-augmentation: prefix: "tapi-eth" namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.PmCurrentDataAugmentation4: + tapi.eth.InputAugmentation4: type: "object" properties: - eth-on-demand-1-dm-performance-data: + eth-pro-active-single-ended-measurement-job: description: "none" - $ref: "#/definitions/tapi.eth.EthOnDemand1DmPerformanceData" + $ref: "#/definitions/tapi.eth.EthProActiveSingleEndedMeasurementJob" x-augmentation: prefix: "tapi-eth" namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.PmCurrentDataAugmentation5: + tapi.eth.InputAugmentation5: type: "object" properties: - eth-pro-active-dm-performance-data: + eth-on-demand-dual-ended-measurement-job: description: "none" - $ref: "#/definitions/tapi.eth.EthProActiveDmPerformanceData" + $ref: "#/definitions/tapi.eth.EthOnDemandDualEndedMeasurementJob" x-augmentation: prefix: "tapi-eth" namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.PmCurrentDataAugmentation6: + tapi.eth.InputAugmentation6: type: "object" properties: - eth-on-demand-1-lm-performance-data: + eth-on-demand-single-ended-measurement-job: description: "none" - $ref: "#/definitions/tapi.eth.EthOnDemand1LmPerformanceData" + $ref: "#/definitions/tapi.eth.EthOnDemandSingleEndedMeasurementJob" x-augmentation: prefix: "tapi-eth" namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.PmCurrentDataAugmentation7: + tapi.eth.InputAugmentation7: type: "object" properties: - eth-on-demand-lm-performance-data: + eth-pro-active-dual-ended-measurement-job: description: "none" - $ref: "#/definitions/tapi.eth.EthOnDemandLmPerformanceData" + $ref: "#/definitions/tapi.eth.EthProActiveDualEndedMeasurementJob" x-augmentation: prefix: "tapi-eth" namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.PmCurrentDataAugmentation8: + tapi.eth.LinkTraceResult: type: "object" properties: - eth-pro-active-lm-performance-data: + data-tlv-length: + type: "integer" + format: "int32" + description: "G.8052: This attribute contains the length (in number of octets)\ + \ of the Data TLV of an individual LTR frame result." + time-to-live: + type: "integer" + format: "int32" + description: "G.8052: This attribute contains the Time To Live (TTL) value\ + \ of an individual LTR frame result." + source-address: + type: "string" + description: "G.8052: This attribute contains the source MAC Address of an\ + \ individual LTR frame result." + tapi.eth.LldpChassisIdSubtype: + type: "object" + properties: + mac-address: + type: "string" + description: "Represents a chassis identifier based on the value of a unicast\ + \ source address (encoded in network byte order and IEEE 802.3 canonical\ + \ bit order), of a port on the containing chassis as defined in IEEE Std\ + \ 802-2001." + chassis-component: + type: "string" + description: "String length '0..32'\r\n Represents a chassis\ + \ identifier based on the value of entPhysicalAlias object (defined in IETF\ + \ RFC 2737) for a chassis component (i.e., an entPhysicalClass value of\ + \ chassis(3))." + interface-name: + type: "string" + description: "Represents a chassis identifier based on the value of ifName\ + \ object (defined in IETF RFC 2863) for an interface on the containing chassis." + network-address: + type: "string" + description: "Octet string that identifies a particular network address family\ + \ and an associated network address that are encoded in network octet order.\r\ + \n An IP address, for example, would be encoded with the\ + \ first octet containing the IANA Address Family Numbers enumeration value\ + \ for the specific address type and octets 2 through n containing the address\ + \ value." + interface-alias: + type: "string" + description: "String length '0..64'\r\n Represents a chassis\ + \ identifier based on the value of ifAlias object (defined in IETF RFC 2863)\ + \ for an interface on the containing chassis." + port-component: + type: "string" + description: "String length '0..32'\r\n Represents a chassis\ + \ identifier based on the value of entPhysicalAlias object (defined in IETF\ + \ RFC 2737) for a port or backplane component (i.e., entPhysicalClass value\ + \ of port(10) or backplane(4)), within the containing chassis." + local: + type: "string" + description: "Represents a chassis identifier based on a locally defined value." + tapi.eth.LldpPortIdSubtype: + type: "object" + properties: + agent-circuit-id: + type: "string" + description: "Represents a port identifier based on the agent-local identifier\ + \ of the circuit (defined in RFC 3046), detected by the agent and associated\ + \ with a particular port." + mac-address: + type: "string" + description: "Represents a port identifier based on a unicast source address\ + \ (encoded in network byte order and IEEE 802.3 canonical bit order), which\ + \ has been detected by the agent and associated with a particular port (IEEE\ + \ Std 802-2001)." + interface-name: + type: "string" + description: "String length '0..64'\r\n Represents a port identifier\ + \ based on the ifName MIB object, defined in IETF RFC 2863." + network-address: + type: "string" + description: "Represents a port identifier based on a network address, detected\ + \ by the agent and associated with a particular port.\r\n \ + \ Octet string that identifies a particular network address family and\ + \ an associated network address that are encoded in network octet order.\r\ + \n An IP address, for example, would be encoded with the\ + \ first octet containing the IANA Address Family Numbers enumeration value\ + \ for the specific address type and octets 2 through n containing the address\ + \ value.\r\n " + interface-alias: + type: "string" + description: "String length '0..64'\r\n Represents a port identifier\ + \ based on the ifAlias MIB object, defined in IETF RFC 2863." + port-component: + type: "string" + description: "String length '0..32'\r\n Represents a port identifier\ + \ based on the value of entPhysicalAlias (defined in IETF RFC 2737) for\ + \ a port component (i.e., entPhysicalClass value of port(10)), within the\ + \ containing chassis." + local: + type: "string" + description: "Represents a port identifier based on a value locally assigned." + tapi.eth.MaintenanceAssociationName: + type: "object" + properties: + char-string: + type: "string" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ RFC2579 DisplayString, except that the character codes 0-31 (decimal)\ + \ are not used.\r\n Length '1..45'" + ieee-reserved: + type: "string" + description: "IEEE P802.1Qcx/D0.3:\r\n Reserved for definition\ + \ by IEEE 802.1. Recommend not to use zero unless absolutely needed.\r\n\ + \ Length '1..45'." + default: "0" + unsigned-int-16: + type: "integer" + format: "int32" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ 2-octet integer/big endian." + icc-format: + type: "string" + description: "IEEE P802.1Qcx/D0.3:\r\n ICC-based format as\ + \ specified in ITU-T Y.1731.\r\n Length '1..45'" + primary-vlan-id: + type: "string" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ Primary VLAN ID. 12 bits represented in a 2-octet integer." + rfc-2865-vpn-id: + type: "string" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ RFC2685 VPN ID. 3 octet VPN authority Organizationally Unique Identifier\ + \ followed by 4 octet VPN index identifying VPN according to the OUI.\r\n\ + \ Length '1..45';" + tapi.eth.MegAugmentation1: + type: "object" + properties: + eth-meg-spec: description: "none" - $ref: "#/definitions/tapi.eth.EthProActiveLmPerformanceData" + $ref: "#/definitions/tapi.eth.EthMegSpec" x-augmentation: prefix: "tapi-eth" namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.PmCurrentDataAugmentation9: + tapi.eth.MepAugmentation1: type: "object" properties: - eth-pro-active-1-lm-performance-data: + eth-mep-spec: description: "none" - $ref: "#/definitions/tapi.eth.EthProActive1LmPerformanceData" + $ref: "#/definitions/tapi.eth.EthMepSpec" x-augmentation: prefix: "tapi-eth" namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.PmHistoryDataAugmentation1: + tapi.eth.MipAugmentation1: type: "object" properties: - eth-on-demand-dm-performance-data: + eth-mip-spec: description: "none" - $ref: "#/definitions/tapi.eth.EthOnDemandDmPerformanceData" + $ref: "#/definitions/tapi.eth.EthMipSpec" x-augmentation: prefix: "tapi-eth" namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.PmHistoryDataAugmentation2: + tapi.eth.OamJobAugmentation1: type: "object" properties: - eth-on-demand-1-lm-performance-data: + eth-loopback-job: description: "none" - $ref: "#/definitions/tapi.eth.EthOnDemand1LmPerformanceData" + $ref: "#/definitions/tapi.eth.EthLoopbackJob" x-augmentation: prefix: "tapi-eth" namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.PmHistoryDataAugmentation3: + tapi.eth.OamJobAugmentation2: type: "object" properties: - eth-pro-active-lm-performance-data: + eth-test-job: description: "none" - $ref: "#/definitions/tapi.eth.EthProActiveLmPerformanceData" + $ref: "#/definitions/tapi.eth.EthTestJob" x-augmentation: prefix: "tapi-eth" namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.PmHistoryDataAugmentation4: + tapi.eth.OamJobAugmentation3: type: "object" properties: - eth-on-demand-1-dm-performance-data: + eth-link-trace-job: description: "none" - $ref: "#/definitions/tapi.eth.EthOnDemand1DmPerformanceData" + $ref: "#/definitions/tapi.eth.EthLinkTraceJob" x-augmentation: prefix: "tapi-eth" namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.PmHistoryDataAugmentation5: + tapi.eth.OamJobAugmentation4: type: "object" properties: - eth-pro-active-dm-performance-data: + eth-on-demand-single-ended-measurement-job: description: "none" - $ref: "#/definitions/tapi.eth.EthProActiveDmPerformanceData" + $ref: "#/definitions/tapi.eth.EthOnDemandSingleEndedMeasurementJob" x-augmentation: prefix: "tapi-eth" namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.PmHistoryDataAugmentation6: + tapi.eth.OamJobAugmentation5: type: "object" properties: - eth-pro-active-1-dm-performance-data: + eth-pro-active-single-ended-measurement-job: description: "none" - $ref: "#/definitions/tapi.eth.EthProActive1DmPerformanceData" + $ref: "#/definitions/tapi.eth.EthProActiveSingleEndedMeasurementJob" x-augmentation: prefix: "tapi-eth" namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.PmHistoryDataAugmentation7: + tapi.eth.OamJobAugmentation6: type: "object" properties: - eth-pro-active-1-lm-performance-data: + eth-pro-active-dual-ended-measurement-job: description: "none" - $ref: "#/definitions/tapi.eth.EthProActive1LmPerformanceData" + $ref: "#/definitions/tapi.eth.EthProActiveDualEndedMeasurementJob" x-augmentation: prefix: "tapi-eth" namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.PmHistoryDataAugmentation8: + tapi.eth.OamJobAugmentation7: type: "object" properties: - eth-on-demand-lm-performance-data: + eth-on-demand-dual-ended-measurement-job: description: "none" - $ref: "#/definitions/tapi.eth.EthOnDemandLmPerformanceData" + $ref: "#/definitions/tapi.eth.EthOnDemandDualEndedMeasurementJob" x-augmentation: prefix: "tapi-eth" namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.PmThresholdDataAugmentation1: + tapi.eth.OamPduGenerationType: + type: "string" + enum: + - "SINGLE_INSTANCE" + - "REPETITIVE_INSTANCE" + - "SINGLE_SERIES" + - "REPETITIVE_SERIES" + tapi.eth.OamPeriod: + type: "string" + enum: + - "3_33MS" + - "10MS" + - "100MS" + - "1S" + - "10S" + - "1MIN" + - "10MIN" + tapi.eth.OamServiceAugmentation1: type: "object" properties: - eth-lm-threshold-data: + eth-oam-service: description: "none" - $ref: "#/definitions/tapi.eth.EthLmThresholdData" + $ref: "#/definitions/tapi.eth.EthOamService" x-augmentation: prefix: "tapi-eth" namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.PmThresholdDataAugmentation2: + tapi.eth.OamServicePointAugmentation1: type: "object" properties: - eth-dm-threshold-data: + eth-oam-mip-service-point: description: "none" - $ref: "#/definitions/tapi.eth.EthDmThresholdData" + $ref: "#/definitions/tapi.eth.EthOamMipServicePoint" x-augmentation: prefix: "tapi-eth" namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.PmThresholdDataAugmentation3: + tapi.eth.OamServicePointAugmentation2: type: "object" properties: - eth-1-dm-threshold-data: + eth-oam-mep-service-point: description: "none" - $ref: "#/definitions/tapi.eth.Eth1DmThresholdData" + $ref: "#/definitions/tapi.eth.EthOamMepServicePoint" x-augmentation: prefix: "tapi-eth" namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.PmThresholdDataAugmentation4: + tapi.eth.OamServicePointAugmentation3: type: "object" properties: - eth-1-lm-threshold-data: + eth-oam-mep-service-point: description: "none" - $ref: "#/definitions/tapi.eth.Eth1LmThresholdData" + $ref: "#/definitions/tapi.eth.EthOamMepServicePoint" x-augmentation: prefix: "tapi-eth" namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.PcpCoding: + type: "string" + enum: + - "8P0D" + - "7P1D" + - "6P2D" + - "5P3D" + - "DEI" tapi.eth.PriorityConfiguration: type: "object" properties: @@ -21972,25 +22655,77 @@ definitions: tapi.eth.QueueConfiguration: type: "object" properties: - queue-threshold: - type: "integer" - format: "int32" - description: "This attribute defines the threshold of the queue in bytes." - queue-id: - type: "integer" - format: "int32" - description: "This attribute indicates the queue id." - queue-depth: - type: "integer" - format: "int32" - description: "This attribute defines the depth of the queue in bytes." - tapi.eth.RepetitionPeriod: - type: "string" - enum: - - "1MIN" - - "1S" - - "10S" - - "0" + queue-threshold: + type: "integer" + format: "int32" + description: "This attribute defines the threshold of the queue in bytes." + queue-id: + type: "integer" + format: "int32" + description: "This attribute indicates the queue id." + queue-depth: + type: "integer" + format: "int32" + description: "This attribute defines the depth of the queue in bytes." + tapi.eth.RepetitionPeriod: + type: "string" + enum: + - "1MIN" + - "1S" + - "10S" + - "0" + tapi.eth.SamplesDmPerformanceParameters: + type: "object" + properties: + frame-delay-variation-list: + type: "array" + description: "This attribute contains the frame delay variations measured\ + \ in ns (nano second). The multiplicity is defined by (numberOfSamples\ + \ - 1, for numberOfSamples > 0)." + items: + type: "integer" + format: "int32" + number-of-samples: + type: "integer" + format: "int32" + description: "This attribute contains the number of received DM frames (successful\ + \ samples) used for this frame delay measurement.\r\n range\ + \ of type : non-negative" + frame-delay-list: + type: "array" + description: "This attribute contains the frame delays measured in ns (nano\ + \ second, 1x10e-9 seconds). The multiplicity is defined by the numberOfSamples\ + \ attribute." + items: + type: "integer" + format: "int32" + tapi.eth.ServiceAugmentation1: + type: "object" + properties: + eth-connectivity-service: + description: "none" + $ref: "#/definitions/tapi.eth.EthConnectivityService" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.ServiceInterfacePointAugmentation1: + type: "object" + properties: + eth-service-inteface-point-spec: + description: "none" + $ref: "#/definitions/tapi.eth.EthServiceIntefacePointSpec" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.SipAugmentation1: + type: "object" + properties: + eth-service-inteface-point-spec: + description: "none" + $ref: "#/definitions/tapi.eth.EthServiceIntefacePointSpec" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" tapi.eth.StatisticalDmPerformanceParameters: type: "object" properties: @@ -22006,6 +22741,13 @@ definitions: description: "This attribute contains the maximum frame delay observed over\ \ the monitored period. It is measured in units of ns (nano second, 1x10e-9\ \ seconds)." + average-inter-frame-delay-variation: + type: "integer" + format: "int32" + description: "This attribute contains the average frame delay variation measured\ + \ in units of ns (nano second, 1x10e-9 seconds).\r\n G.8013/Y.1731:\r\ + \n Frame delay variation is a measure of the variations in\ + \ the frame delay between a pair of service frames" minimum-frame-delay: type: "integer" format: "int32" @@ -22016,47 +22758,90 @@ definitions: type: "integer" format: "int32" description: "This attribute contains the maximum frame delay variation measured\ - \ in units of ns (nano second, 1x10e-9 seconds)." + \ in units of ns (nano second, 1x10e-9 seconds).\r\n Y.1563:\r\ + \n The 2-point frame delay variation (vk) for an Ethernet\ + \ frame k between SRC and DST is the difference between the absolute Ethernet\ + \ frame transfer delay (xk) of frame k and a defined reference Ethernet\ + \ frame transfer delay, d1,2, between those same MPs: vk = xk d1,2." minimum-frame-delay-variation: type: "integer" format: "int32" description: "This attribute contains the minimum frame delay variation measured\ - \ in units of ns (nano second, 1x10e-9 seconds)." + \ in units of ns (nano second, 1x10e-9 seconds).\r\n Y.1563:\r\ + \n The 2-point frame delay variation (vk) for an Ethernet\ + \ frame k between SRC and DST is the difference between the absolute Ethernet\ + \ frame transfer delay (xk) of frame k and a defined reference Ethernet\ + \ frame transfer delay, d1,2, between those same MPs: vk = xk d1,2." + minimum-inter-frame-delay-variation: + type: "integer" + format: "int32" + description: "This attribute contains the minimum frame delay variation measured\ + \ in units of ns (nano second, 1x10e-9 seconds).\r\n G.8013/Y.1731:\r\ + \n Frame delay variation is a measure of the variations in\ + \ the frame delay between a pair of service frames" + maximum-inter-frame-delay-variation: + type: "integer" + format: "int32" + description: "This attribute contains the maximum frame delay variation measured\ + \ in units of ns (nano second, 1x10e-9 seconds).\r\n G.8013/Y.1731:\r\ + \n Frame delay variation is a measure of the variations in\ + \ the frame delay between a pair of service frames" average-frame-delay-variation: type: "integer" format: "int32" description: "This attribute contains the average frame delay variation measured\ - \ in units of ns (nano second, 1x10e-9 seconds)." + \ in units of ns (nano second, 1x10e-9 seconds).\r\n Y.1563:\r\ + \n The 2-point frame delay variation (vk) for an Ethernet\ + \ frame k between SRC and DST is the difference between the absolute Ethernet\ + \ frame transfer delay (xk) of frame k and a defined reference Ethernet\ + \ frame transfer delay, d1,2, between those same MPs: vk = xk d1,2." tapi.eth.StatisticalLmPerformanceParameters: type: "object" properties: - ses: - type: "integer" - format: "int32" - description: "This attribute contains the SES detected in the monitoring interval.\r\ - \n range of type : 0..900 for 15min interval or 0..86400\ - \ for 24 hr interval." average-frame-loss-ratio: type: "string" description: "This attribute contains the average frame loss ratio calculated\ - \ over a period of time.\r\n The accuracy of the value\ - \ is for further study." + \ over a period of time." + unavailable-intervals: + type: "integer" + format: "int32" + description: "A generalized UAS.\r\n MEF 35.1: A 32-bit counter\ + \ reflecting the number of delta-t intervals evaluated as Unavailable (i.e.,\ + \ for which A(delta-t) = 0).\r\n range\ + \ of type : 0..900 for 15min interval or 0..86400 for 24 hr interval." + hli-count: + type: "integer" + format: "int32" + description: "A generalized SES.\r\n MEF 10.3: The Resiliency\ + \ attributes are similar to the definitions of Severely Errored Seconds\ + \ (SES) and Consecutive SES in section 9 and Annex B (respectively) of Y.1563\ + \ [6], when delta-t = 1 second.\r\n MEF 35.1: Count of High\ + \ Loss Intervals during the Measurement Interval.\r\n range\ + \ of type : 0..900 for 15min interval or 0..86400 for 24 hr interval." maximum-frame-loss-ratio: type: "string" description: "This attribute contains the maximum frame loss ratio calculated\ - \ over a period of time.\r\n The accuracy of the value\ - \ is for further study." - uas: - type: "integer" - format: "int32" - description: "This attribute contains UAS (unavailable seconds) detected in\ - \ the monitoring interval.\r\n range of type : 0..900\ - \ for 15min interval or 0..86400 for 24 hr interval." + \ over a period of time." minimum-frame-loss-ratio: type: "string" description: "This attribute contains the minimum frame loss ratio calculated\ - \ over a period of time.\r\n The accuracy of the value\ - \ is for further study." + \ over a period of time." + tapi.eth.TotalCountersLmPerformanceParameters: + type: "object" + properties: + total-transmitted-frames: + type: "integer" + format: "int32" + description: "This attribute contains the total number of frames transmitted." + total-frame-loss-ratio: + type: "string" + description: "This attribute contains the frame loss ratio (number of lost\ + \ frames divided by the number of total frames (N_LF / N_TF)).\r\n \ + \ The accuracy of the value is for further study." + total-lost-frames: + type: "integer" + format: "int32" + description: "This attribute contains the total number of frames lost." tapi.eth.TrafficConditioningConfiguration: type: "object" properties: @@ -22108,13 +22893,13 @@ definitions: cond-config-list: type: "array" description: "This attribute indicates for the conditioner process the conditioning\ - \ parameters:\r\n - Queue ID: Indicates the Queue ID\r\ - \n - Committed Information Rate (CIR): number of bits\ - \ per second\r\n - Committed Burst Size (CBS): number\ - \ of bytes\r\n - Excess Information Rate (EIR): number\ - \ of bits per second\r\n - Excess Burst Size (EBS): number\ - \ of bytes\r\n - Coupling flag (CF): 0 or 1\r\n \ - \ - Color mode (CM): color-blind and color-aware." + \ parameters:\r\n - Queue ID: Indicates the Queue ID\r\n\ + \ - Committed Information Rate (CIR): number of bits per\ + \ second\r\n - Committed Burst Size (CBS): number of bytes\r\ + \n - Excess Information Rate (EIR): number of bits per second\r\ + \n - Excess Burst Size (EBS): number of bytes\r\n \ + \ - Coupling flag (CF): 0 or 1\r\n - Color mode (CM):\ + \ color-blind and color-aware." items: $ref: "#/definitions/tapi.eth.TrafficConditioningConfiguration" tapi.eth.TrafficShapingPac: @@ -22132,12 +22917,12 @@ definitions: type: "string" description: "This attribute configures the scheduler process. The value of\ \ this attribute is for further study because it is for further study in\ - \ G.8021.\r\n Scheduler is a pointer to a Scheduler object,\ + \ G.8021.\r\n Scheduler is a pointer to a Scheduler object,\ \ which is to be defined in the future (because in G.8021, this is FFS).\r\ - \n Note that the only significance of the GTCS function\ - \ defined in G.8021 is the use of a common scheduler for shaping. Given\ - \ that, G.8052 models the common scheduler feature by having a common value\ - \ for this attribute." + \n Note that the only significance of the GTCS function defined\ + \ in G.8021 is the use of a common scheduler for shaping. Given that, G.8052\ + \ models the common scheduler feature by having a common value for this\ + \ attribute." queue-config-list: type: "array" description: "This attribute configures the Queue depth and Dropping threshold\ @@ -22162,28 +22947,12 @@ definitions: - "C_Tag" - "S_Tag" - "I_Tag" - tapi.notification.AlarmInfo: - type: "object" - properties: - perceived-severity: - description: "none" - $ref: "#/definitions/tapi.notification.PerceivedSeverityType" - probable-cause: - type: "string" - description: "none" - service-affecting: - description: "none" - $ref: "#/definitions/tapi.notification.ServiceAffecting" - is-transient: - type: "boolean" - description: "none" - default: false tapi.notification.ContextAugmentation1: type: "object" properties: notification-context: description: "Augments the base TAPI Context with NotificationService information" - $ref: "#/definitions/tapi.notification.NotificationContext" + $ref: "#/definitions/tapi.notification.context.NotificationContext" x-augmentation: prefix: "tapi-notification" namespace: "urn:onf:otcc:yang:tapi-notification" @@ -22192,11 +22961,6 @@ definitions: properties: output: $ref: "#/definitions/tapi.notification.createnotificationsubscriptionservice.Output" - tapi.notification.DeleteNotificationSubscriptionService: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.notification.deletenotificationsubscriptionservice.Output" tapi.notification.GetNotificationList: type: "object" properties: @@ -22235,8 +22999,8 @@ definitions: - type: "object" properties: target-object-type: + type: "string" description: "none" - $ref: "#/definitions/tapi.notification.ObjectType" additional-text: type: "string" description: "none" @@ -22252,18 +23016,15 @@ definitions: type: "integer" format: "int32" description: "A monotonous increasing sequence number associated with the\ - \ notification.\r\n The exact semantics of how this\ - \ sequence number is assigned (per channel or subscription or source or\ - \ system) is left undefined." - tca-info: - description: "none" - $ref: "#/definitions/tapi.notification.TcaInfo" + \ notification.\r\n The exact semantics of how this sequence\ + \ number is assigned (per channel or subscription or source or system)\ + \ is left undefined." target-object-identifier: type: "string" description: "none" notification-type: + type: "string" description: "none" - $ref: "#/definitions/tapi.notification.NotificationType" target-object-name: type: "array" description: "none" @@ -22275,9 +23036,9 @@ definitions: source-indicator: description: "none" $ref: "#/definitions/tapi.notification.SourceIndicator" - alarm-info: + layer-protocol-qualifier: + type: "string" description: "none" - $ref: "#/definitions/tapi.notification.AlarmInfo" changed-attributes: type: "array" description: "none" @@ -22297,23 +23058,10 @@ definitions: stream-address: type: "string" description: "The address/location/URI of the channel/stream to which the\ - \ subscribed notifications are published.\r\n This\ - \ specifics of this is typically dependent on the implementation protocol\ - \ & mechanism and hence is typed as a string." + \ subscribed notifications are published.\r\n This specifics\ + \ of this is typically dependent on the implementation protocol & mechanism\ + \ and hence is typed as a string." description: "none" - tapi.notification.NotificationContext: - type: "object" - properties: - notif-subscription: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - notification: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.Notification" tapi.notification.NotificationSubscriptionService: allOf: - $ref: "#/definitions/tapi.common.GlobalClass" @@ -22334,68 +23082,16 @@ definitions: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.ObjectType" + type: "string" supported-notification-types: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.NotificationType" + type: "string" subscription-filter: description: "none" $ref: "#/definitions/tapi.notification.SubscriptionFilter" description: "none" - tapi.notification.NotificationType: - type: "string" - enum: - - "OBJECT_CREATION" - - "OBJECT_DELETION" - - "ATTRIBUTE_VALUE_CHANGE" - - "ALARM_EVENT" - - "THRESHOLD_CROSSING_ALERT" - tapi.notification.ObjectType: - type: "string" - enum: - - "TOPOLOGY" - - "NODE" - - "LINK" - - "CONNECTION" - - "PATH" - - "CONNECTIVITY_SERVICE" - - "VIRTUAL_NETWORK_SERVICE" - - "PATH_COMPUTATION_SERVICE" - - "NODE_EDGE_POINT" - - "SERVICE_INTERFACE_POINT" - - "CONNECTION_END_POINT" - - "MAINTENANCE_ENTITY_GROUP" - - "MAINTENANCE_ENTITY" - - "MEG_END_POINT" - - "MEG_INTERMEDIATE_POINT" - - "SWITCH_CONTROL" - - "SWITCH" - - "ROUTE" - - "NODE_RULE_GROUP" - - "INTER_RULE_GROUP" - - "RULE" - - "OAM_JOB" - tapi.notification.PerceivedSeverityType: - type: "string" - enum: - - "CRITICAL" - - "MAJOR" - - "MINOR" - - "WARNING" - - "CLEARED" - tapi.notification.PerceivedTcaSeverity: - type: "string" - enum: - - "WARNING" - - "CLEAR" - tapi.notification.ServiceAffecting: - type: "string" - enum: - - "SERVICE_AFFECTING" - - "NOT_SERVICE_AFFECTING" - - "UNKNOWN" tapi.notification.SourceIndicator: type: "string" enum: @@ -22411,7 +23107,7 @@ definitions: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.NotificationType" + type: "string" requested-object-identifier: type: "array" description: "none" @@ -22432,57 +23128,56 @@ definitions: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.ObjectType" + type: "string" description: "none" tapi.notification.SubscriptionState: type: "string" enum: - "SUSPENDED" - "ACTIVE" - tapi.notification.TcaInfo: - type: "object" - properties: - threshold-crossing: - description: "none" - $ref: "#/definitions/tapi.notification.ThresholdCrossingType" - threshold-parameter: - type: "string" - description: "none" - is-transient: - type: "boolean" - description: "none" - default: false - threshold-value: - type: "integer" - format: "int32" - description: "none" - perceived-severity: - description: "none" - $ref: "#/definitions/tapi.notification.PerceivedTcaSeverity" - suspect-interval-flag: - type: "boolean" - description: "none" - default: false - measurement-interval: - type: "string" - description: "none" - tapi.notification.ThresholdCrossingType: - type: "string" - enum: - - "THRESHOLD_ABOVE" - - "THRESHOLD_BELOW" - - "CLEARED" tapi.notification.UpdateNotificationSubscriptionService: type: "object" properties: output: $ref: "#/definitions/tapi.notification.updatenotificationsubscriptionservice.Output" + tapi.notification.context.NotificationContext: + allOf: + - type: "object" + properties: + notif-subscription: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + notification: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.notificationcontext.Notification" + description: "Augments the base TAPI Context with NotificationService information" tapi.notification.createnotificationsubscriptionservice.Input: type: "object" properties: subscription-state: description: "none" $ref: "#/definitions/tapi.notification.SubscriptionState" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" subscription-filter: description: "none" $ref: "#/definitions/tapi.notification.SubscriptionFilter" @@ -22495,24 +23190,33 @@ definitions: tapi.notification.deletenotificationsubscriptionservice.Input: type: "object" properties: - subscription-id-or-name: + uuid: type: "string" - description: "none" - tapi.notification.deletenotificationsubscriptionservice.Output: - type: "object" - properties: - subscription-service: - description: "none" - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.notification.getnotificationlist.Input: type: "object" properties: - time-period: - type: "string" - description: "none" - subscription-id-or-name: - type: "string" + time-range: description: "none" + $ref: "#/definitions/tapi.common.TimeRange" + subscription-id: + type: "string" + description: "UUID of the associated Notification Subscription Service: An\ + \ identifier that is universally unique within an identifier space, where\ + \ the identifier space is itself globally unique, and immutable.\r\n \ + \ An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.notification.getnotificationlist.Output: type: "object" properties: @@ -22520,13 +23224,20 @@ definitions: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.Notification" + $ref: "#/definitions/tapi.notification.notificationcontext.Notification" tapi.notification.getnotificationsubscriptionservicedetails.Input: type: "object" properties: - subscription-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.notification.getnotificationsubscriptionservicedetails.Output: type: "object" properties: @@ -22548,31 +23259,66 @@ definitions: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.ObjectType" + type: "string" supported-notification-types: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.NotificationType" + type: "string" + tapi.notification.notificationcontext.Notification: + allOf: + - $ref: "#/definitions/tapi.notification.Notification" + - $ref: "#/definitions/tapi.oam.NotificationAugmentation1" + - $ref: "#/definitions/tapi.oam.NotificationAugmentation2" tapi.notification.updatenotificationsubscriptionservice.Input: type: "object" properties: subscription-state: description: "none" $ref: "#/definitions/tapi.notification.SubscriptionState" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" subscription-filter: description: "none" $ref: "#/definitions/tapi.notification.SubscriptionFilter" - subscription-id-or-name: - type: "string" - description: "none" tapi.notification.updatenotificationsubscriptionservice.Output: type: "object" properties: subscription-service: description: "none" $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - tapi.oam.ConnectionEndPointAugmentation2: + tapi.oam.AlarmInfo: + type: "object" + properties: + perceived-severity: + description: "none" + $ref: "#/definitions/tapi.oam.PerceivedSeverityType" + probable-cause: + type: "string" + description: "none" + service-affecting: + description: "none" + $ref: "#/definitions/tapi.oam.ServiceAffecting" + is-transient: + type: "boolean" + description: "none" + default: false + tapi.oam.ConnectionEndPointAugmentation1: type: "object" properties: mep-mip-list: @@ -22581,7 +23327,7 @@ definitions: x-augmentation: prefix: "tapi-oam" namespace: "urn:onf:otcc:yang:tapi-oam" - tapi.oam.ContextAugmentation2: + tapi.oam.ContextAugmentation3: type: "object" properties: oam-context: @@ -22595,16 +23341,47 @@ definitions: properties: output: $ref: "#/definitions/tapi.oam.createoamjob.Output" + tapi.oam.CreateOamProfile: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.createoamprofile.Output" tapi.oam.CreateOamService: type: "object" properties: output: $ref: "#/definitions/tapi.oam.createoamservice.Output" - tapi.oam.CreateOamServiceEndPoint: + tapi.oam.CreateOamServicePoint: type: "object" properties: output: - $ref: "#/definitions/tapi.oam.createoamserviceendpoint.Output" + $ref: "#/definitions/tapi.oam.createoamservicepoint.Output" + tapi.oam.CurrentData: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + elapsed-time: + description: "none" + $ref: "#/definitions/tapi.common.TimeInterval" + period-start-time: + type: "string" + description: "This attribute indicates the start of the current monitoring\ + \ interval.\r\n The value is bound to the quarter of an\ + \ hour in case of a 15 minute interval and bound to the hour in case of\ + \ a 24 hour interval." + pm-data-pac: + description: "none" + $ref: "#/definitions/tapi.oam.PmDataPac" + history-data: + type: "array" + description: "in case of 24hr Current Data, at least 1 History Data.\r\n\ + \ In case of 15min Current Data, at least 16 History Data.\r\ + \n In case of <15min, the number of History Data shall\ + \ be able to cover a span of 4 hours." + items: + $ref: "#/definitions/tapi.oam.HistoryData" + description: "none" tapi.oam.GetMeg: type: "object" properties: @@ -22615,53 +23392,52 @@ definitions: properties: output: $ref: "#/definitions/tapi.oam.getoamjob.Output" - tapi.oam.GetOamService: + tapi.oam.GetOamJobList: type: "object" properties: output: - $ref: "#/definitions/tapi.oam.getoamservice.Output" - tapi.oam.GetOamServiceEndPoint: + $ref: "#/definitions/tapi.oam.getoamjoblist.Output" + tapi.oam.GetOamProfile: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getoamprofile.Output" + tapi.oam.GetOamProfileList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getoamprofilelist.Output" + tapi.oam.GetOamService: type: "object" properties: output: - $ref: "#/definitions/tapi.oam.getoamserviceendpoint.Output" + $ref: "#/definitions/tapi.oam.getoamservice.Output" tapi.oam.GetOamServiceList: type: "object" properties: output: $ref: "#/definitions/tapi.oam.getoamservicelist.Output" - tapi.oam.Meg: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.common.OperationalStatePac" - - type: "object" - properties: - meg-identifier: - type: "string" - description: "none" - meg-level: - type: "integer" - format: "int32" - description: "none" - mip: - type: "array" - description: "ME may 0, 1, or more MIPs" - items: - $ref: "#/definitions/tapi.oam.Mip" - layer-protocol-name: + tapi.oam.GetOamServicePoint: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getoamservicepoint.Output" + tapi.oam.HistoryData: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + period-start-time: + type: "string" + description: "This attribute indicates the start of the monitoring interval.\r\ + \n The value is bound to the quarter of an hour in case\ + \ of a 15 minute interval and bound to the hour in case of a 24 hour interval." + pm-data-pac: description: "none" - $ref: "#/definitions/tapi.common.LayerProtocolName" - mep: - type: "array" - description: "1. ME may have 0 MEPs (case of transit domains where at least\ - \ 1 MIP is present)\r\n 2. ME may have 1 MEP (case\ - \ of edge domaind, where the peer MEP is ouside the managed domain)\r\n\ - \ 3. ME may have 2 MEPs" - items: - $ref: "#/definitions/tapi.oam.Mep" - direction: + $ref: "#/definitions/tapi.oam.PmDataPac" + period-end-time: + type: "string" description: "none" - $ref: "#/definitions/tapi.common.ForwardingDirection" description: "none" tapi.oam.MegRef: type: "object" @@ -22679,17 +23455,6 @@ definitions: layer-protocol-name: description: "none" $ref: "#/definitions/tapi.common.LayerProtocolName" - peer-mep-identifier: - type: "array" - description: "none" - items: - type: "string" - mep-identifier: - type: "string" - description: "none" - direction: - description: "none" - $ref: "#/definitions/tapi.common.TerminationDirection" description: "none" tapi.oam.MepMipList: type: "object" @@ -22733,19 +23498,24 @@ definitions: description: "none" x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:meg/tapi-oam:mip/tapi-oam:local-id" description: "none" - tapi.oam.OamConstraint: + tapi.oam.NotificationAugmentation1: type: "object" properties: - layer-protocol-name: - description: "none" - $ref: "#/definitions/tapi.common.LayerProtocolName" - meg-level: - type: "integer" - format: "int32" + tca-info: description: "none" - direction: + $ref: "#/definitions/tapi.oam.TcaInfo" + x-augmentation: + prefix: "tapi-oam" + namespace: "urn:onf:otcc:yang:tapi-oam" + tapi.oam.NotificationAugmentation2: + type: "object" + properties: + alarm-info: description: "none" - $ref: "#/definitions/tapi.common.ForwardingDirection" + $ref: "#/definitions/tapi.oam.AlarmInfo" + x-augmentation: + prefix: "tapi-oam" + namespace: "urn:onf:otcc:yang:tapi-oam" tapi.oam.OamJob: allOf: - $ref: "#/definitions/tapi.common.AdminStatePac" @@ -22758,27 +23528,34 @@ definitions: oam-profile: description: "none" $ref: "#/definitions/tapi.oam.OamProfileRef" - pm-current-data: - type: "array" - description: "Granularity period of the CurrentData identifies the specific\ - \ CurrentData instance in the scope of this OamJob.\r\n \ - \ For example, typically at least\r\n one 15min\ - \ and\r\n one 24hr;\r\n optionally\ - \ one additional configurable (< 15min)" - items: - $ref: "#/definitions/tapi.oam.PmCurrentData" creation-time: type: "string" description: "none" - oam-service-end-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamServiceEndPointRef" oam-job-type: type: "string" description: "none" + oam-service-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamServicePointRef" + current-data: + type: "array" + description: "Granularity period of the CurrentData identifies the specific\ + \ CurrentData instance in the scope of this OamJob.\r\n \ + \ For example, typically at least\r\n one 15min and\r\n\ + \ one 24hr;\r\n optionally one additional\ + \ configurable (< 15min)" + items: + $ref: "#/definitions/tapi.oam.CurrentData" description: "none" + tapi.oam.OamJobRef: + type: "object" + properties: + oam-job-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-job/tapi-oam:uuid" tapi.oam.OamProfile: allOf: - $ref: "#/definitions/tapi.common.GlobalClass" @@ -22789,11 +23566,6 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.oam.PmThresholdData" - pm-bin-data: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.PmBinData" description: "none" tapi.oam.OamProfileRef: type: "object" @@ -22802,41 +23574,12 @@ definitions: type: "string" description: "none" x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-profile/tapi-oam:uuid" - tapi.oam.OamService: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.oam.OamConstraint" - - type: "object" - properties: - oam-profile: - description: "none" - $ref: "#/definitions/tapi.oam.OamProfileRef" - end-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - meg: - description: "none" - $ref: "#/definitions/tapi.oam.MegRef" - description: "none" - tapi.oam.OamServiceEndPoint: + tapi.oam.OamServicePoint: allOf: - $ref: "#/definitions/tapi.common.AdminStatePac" - $ref: "#/definitions/tapi.common.LocalClass" - type: "object" properties: - peer-mep-identifier: - type: "array" - description: "This attribute models the MI_PeerMEP_ID[i] defined in G.8021\ - \ and configured as specified in G.8051. It provides the identifiers of\ - \ the MEPs which are peer to the subject MEP.\r\n This\ - \ attribute is not specified in case the OSEP relates to the provisioing\ - \ of an MIP.\r\n In case of P2P, there is only one\ - \ peer" - items: - type: "string" connectivity-service-end-point: description: "none" $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" @@ -22846,30 +23589,27 @@ definitions: service-interface-point: description: "none" $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + is-mip: + type: "boolean" + description: "If true, the object is related to a MIP.\r\n \ + \ If false, the object is related to a MEP." + default: false layer-protocol-name: description: "none" $ref: "#/definitions/tapi.common.LayerProtocolName" mep: description: "none" $ref: "#/definitions/tapi.oam.MepRef" - mep-identifier: - type: "string" - description: "This attribute contains the identifier of the MEP.\r\n \ - \ This attribute is empty in case the OSEP relates to\ - \ the provisioing of an MIP.\r\n " - direction: - description: "none" - $ref: "#/definitions/tapi.common.PortDirection" description: "none" - tapi.oam.OamServiceEndPointRef: + tapi.oam.OamServicePointRef: allOf: - $ref: "#/definitions/tapi.oam.OamServiceRef" - type: "object" properties: - oam-service-end-point-local-id: + oam-service-point-local-id: type: "string" description: "none" - x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-service/tapi-oam:end-point/tapi-oam:local-id" + x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-service/tapi-oam:oam-service-point/tapi-oam:local-id" description: "none" tapi.oam.OamServiceRef: type: "object" @@ -22878,7 +23618,49 @@ definitions: type: "string" description: "none" x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-service/tapi-oam:uuid" - tapi.oam.PmBinData: + tapi.oam.PerceivedSeverityType: + type: "string" + enum: + - "CRITICAL" + - "MAJOR" + - "MINOR" + - "WARNING" + - "CLEARED" + tapi.oam.PerceivedTcaSeverity: + type: "string" + enum: + - "WARNING" + - "CLEAR" + tapi.oam.PmDataPac: + type: "object" + properties: + suspect-interval-flag: + type: "boolean" + description: "This attribute is used to indicate that the performance data\ + \ for the current period may not be reliable. Some reasons for this to occur\ + \ are:\r\n Suspect data were detected by the actual resource\ + \ doing data collection.\r\n Transition of the administrativeState\ + \ attribute to/from the 'lock' state.\r\n Transition of\ + \ the operationalState to/from the 'disabled' state.\r\n \ + \ Scheduler setting that inhibits the collection function.\r\n \ + \ The performance counters were reset during the interval.\r\n\ + \ The currentData (or subclass) object instance was created\ + \ during the monitoring period." + default: false + granularity-period: + description: "none" + $ref: "#/definitions/tapi.common.TimePeriod" + tapi.oam.PmParameterValue: + type: "object" + properties: + pm-parameter-int-value: + type: "integer" + format: "int32" + description: "none" + pm-parameter-real-value: + type: "string" + description: "none" + tapi.oam.PmThresholdData: allOf: - $ref: "#/definitions/tapi.common.LocalClass" - type: "object" @@ -22886,91 +23668,102 @@ definitions: granularity-period: description: "none" $ref: "#/definitions/tapi.common.TimePeriod" - description: "none" - tapi.oam.PmCurrentData: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - elapsed-time: - description: "none" - $ref: "#/definitions/tapi.common.TimeInterval" - pm-history-data: + threshold-parameter: type: "array" - description: "in case of 24hr Current Data, at least 1 History Data.\r\n\ - \ In case of 15min Current Data, at least 16 History\ - \ Data.\r\n In case of <15min, the number of History\ - \ Data shall be able to cover a span of 4 hours." - items: - $ref: "#/definitions/tapi.oam.PmHistoryData" - granularity-period: - description: "none" - $ref: "#/definitions/tapi.common.TimePeriod" - suspect-interval-flag: - type: "boolean" - description: "This attribute is used to indicate that the performance data\ - \ for the current period may not be reliable. Some reasons for this to\ - \ occur are:\r\n Suspect data were detected by the\ - \ actual resource doing data collection.\r\n Transition\ - \ of the administrativeState attribute to/from the 'lock' state.\r\n \ - \ Transition of the operationalState to/from the 'disabled'\ - \ state.\r\n Scheduler setting that inhibits the\ - \ collection function.\r\n The performance counters\ - \ were reset during the interval.\r\n The currentData\ - \ (or subclass) object instance was created during the monitoring period." - default: false - timestamp: - type: "string" - description: "This attribute indicates the start of the current monitoring\ - \ interval.\r\n The value is bound to the quarter of\ - \ an hour in case of a 15 minute interval and bound to the hour in case\ - \ of a 24 hour interval." - description: "none" - tapi.oam.PmHistoryData: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - granularity-period: - description: "none" - $ref: "#/definitions/tapi.common.TimePeriod" - period-end-time: - type: "string" description: "none" - suspect-interval-flag: - type: "boolean" - description: "This attribute indicates that the performance data may not\ - \ be reliable." - default: false - description: "none" - tapi.oam.PmThresholdData: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: + items: + $ref: "#/definitions/tapi.oam.ThresholdParameter" is-transient: type: "boolean" description: "none" default: false - granularity-period: - description: "none" - $ref: "#/definitions/tapi.common.TimePeriod" + applicable-job-type: + type: "array" + description: "This attribute allows an PMThresholdData instance to be constrained\ + \ to specific job types. If an PMThresholdData instance is so configured\ + \ to be applicable to more than one job type (worst case ALL), only the\ + \ parameters relevant for the job instance will be used (non-applicable\ + \ profile parameters will be ignored)" + items: + type: "string" description: "none" + tapi.oam.ServiceAffecting: + type: "string" + enum: + - "SERVICE_AFFECTING" + - "NOT_SERVICE_AFFECTING" + - "UNKNOWN" + tapi.oam.TcaInfo: + type: "object" + properties: + oam-job: + description: "MEF 35.1\r\n Identification of the PM Session\ + \ for which the TCA Function was configured." + $ref: "#/definitions/tapi.oam.OamJobRef" + threshold-parameter: + description: "none" + $ref: "#/definitions/tapi.oam.ThresholdParameter" + is-transient: + type: "boolean" + description: "none" + default: false + perceived-severity: + description: "none" + $ref: "#/definitions/tapi.oam.PerceivedTcaSeverity" + suspect-interval-flag: + type: "boolean" + description: "none" + default: false + measurement-interval: + type: "string" + description: "none" + tapi.oam.ThresholdCrossingQualifier: + type: "string" + enum: + - "NOT_APPLICABLE" + - "NEAR_END" + - "FAR_END" + - "BIDIRECTIONAL" + - "FORWARD" + - "BACKWARD" + tapi.oam.ThresholdParameter: + type: "object" + properties: + pm-parameter-below-thrs: + description: "none" + $ref: "#/definitions/tapi.oam.PmParameterValue" + pm-parameter-clear-thrs: + description: "none" + $ref: "#/definitions/tapi.oam.PmParameterValue" + pm-parameter-above-thrs: + description: "none" + $ref: "#/definitions/tapi.oam.PmParameterValue" + pm-parameter-name: + type: "string" + description: "none" + threshold-location: + description: "none" + $ref: "#/definitions/tapi.oam.ThresholdCrossingQualifier" tapi.oam.UpdateOamJob: type: "object" properties: output: $ref: "#/definitions/tapi.oam.updateoamjob.Output" + tapi.oam.UpdateOamProfile: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.updateoamprofile.Output" tapi.oam.UpdateOamService: type: "object" properties: output: $ref: "#/definitions/tapi.oam.updateoamservice.Output" - tapi.oam.UpdateOamServiceEndPoint: + tapi.oam.UpdateOamServicePoint: type: "object" properties: output: - $ref: "#/definitions/tapi.oam.updateoamserviceendpoint.Output" + $ref: "#/definitions/tapi.oam.updateoamservicepoint.Output" tapi.oam.context.OamContext: allOf: - type: "object" @@ -22979,12 +23772,12 @@ definitions: type: "array" description: "none" items: - $ref: "#/definitions/tapi.oam.OamService" + $ref: "#/definitions/tapi.oam.oamcontext.OamService" oam-profile: type: "array" description: "none" items: - $ref: "#/definitions/tapi.oam.oamcontext.OamProfile" + $ref: "#/definitions/tapi.oam.OamProfile" oam-job: type: "array" description: "none" @@ -22997,166 +23790,498 @@ definitions: $ref: "#/definitions/tapi.oam.oamcontext.Meg" description: "Augments the base TAPI Context with OamService information" tapi.oam.createoamjob.Input: + allOf: + - $ref: "#/definitions/tapi.eth.InputAugmentation1" + - $ref: "#/definitions/tapi.eth.InputAugmentation2" + - $ref: "#/definitions/tapi.eth.InputAugmentation3" + - $ref: "#/definitions/tapi.eth.InputAugmentation4" + - $ref: "#/definitions/tapi.eth.InputAugmentation5" + - $ref: "#/definitions/tapi.eth.InputAugmentation6" + - $ref: "#/definitions/tapi.eth.InputAugmentation7" + - type: "object" + properties: + schedule: + description: "none" + $ref: "#/definitions/tapi.common.TimeRange" + name: + type: "array" + description: "List of names. This value is unique in some namespace but\ + \ may change during the life of the entity.\r\n A name\ + \ carries no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + oam-service-point-id: + type: "string" + description: "UUID of the associated OSEPs: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n\ + \ UUID here uses string representation as defined in\ + \ RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of\ + \ a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + oam-job-type: + type: "string" + description: "none" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + oam-profile-id: + type: "string" + description: "UUID of the OamProfile to be applied: An identifier that is\ + \ universally unique within an identifier space, where the identifier\ + \ space is itself globally unique, and immutable.\r\n \ + \ An UUID carries no semantics with respect to the purpose or state\ + \ of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase\ + \ characters.\r\n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of\ + \ a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + oam-service-id: + type: "string" + description: "UUID of the associated OamService: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n\ + \ UUID here uses string representation as defined in\ + \ RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of\ + \ a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the\ + \ purpose or state of the entity.\r\n UUID here uses\ + \ string representation as defined in RFC 4122. The canonical representation\ + \ uses lowercase characters.\r\n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of\ + \ a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + description: "" + tapi.oam.createoamjob.Output: type: "object" properties: - schedule: - type: "string" + oam-job: description: "none" - oam-service-end-point: + $ref: "#/definitions/tapi.oam.getoamjob.output.OamJob" + tapi.oam.createoamprofile.Input: + type: "object" + properties: + name: type: "array" - description: "none" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." items: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - oam-job-type: - type: "string" - description: "none" - oam-profile: - description: "none" - $ref: "#/definitions/tapi.oam.OamProfile" - state: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + pm-threshold-data: + type: "array" description: "none" - tapi.oam.createoamjob.Output: + items: + $ref: "#/definitions/tapi.oam.PmThresholdData" + tapi.oam.createoamprofile.Output: type: "object" properties: - oam-job: + oam-profile: description: "none" - $ref: "#/definitions/tapi.oam.OamJob" + $ref: "#/definitions/tapi.oam.OamProfile" tapi.oam.createoamservice.Input: type: "object" properties: - oam-constraint: - description: "none" - $ref: "#/definitions/tapi.oam.OamConstraint" - state: - type: "string" + layer-protocol-name: description: "none" - end-point: + $ref: "#/definitions/tapi.common.LayerProtocolName" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + oam-service-point: type: "array" description: "none" items: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" + $ref: "#/definitions/tapi.oam.createoamservice.input.OamServicePoint" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.oam.createoamservice.Output: type: "object" properties: - service: + oam-service: + description: "none" + $ref: "#/definitions/tapi.oam.createoamservice.output.OamService" + tapi.oam.createoamservice.input.OamServicePoint: + allOf: + - $ref: "#/definitions/tapi.eth.OamServicePointAugmentation1" + - $ref: "#/definitions/tapi.eth.OamServicePointAugmentation2" + - $ref: "#/definitions/tapi.eth.OamServicePointAugmentation3" + - $ref: "#/definitions/tapi.oam.OamServicePoint" + tapi.oam.createoamservice.output.OamService: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.eth.OamServiceAugmentation1" + - type: "object" + properties: + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + oam-service-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.oamservice.OamServicePoint" + meg: + description: "none" + $ref: "#/definitions/tapi.oam.MegRef" + description: "none" + tapi.oam.createoamservicepoint.Input: + type: "object" + properties: + layer-protocol-name: description: "none" - $ref: "#/definitions/tapi.oam.OamService" - tapi.oam.createoamserviceendpoint.Input: - type: "object" - properties: - peer-mep-identifier: + $ref: "#/definitions/tapi.common.LayerProtocolName" + name: type: "array" - description: "none" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." items: - type: "string" - service-id: - type: "string" - description: "none" - sip-id: - type: "string" - description: "none" - c-sep-id: - type: "string" - description: "none" - mep-identifier: - type: "string" - description: "none" + $ref: "#/definitions/tapi.common.NameAndValue" state: - type: "string" - description: "none" - layer: - type: "string" description: "none" - direction: + $ref: "#/definitions/tapi.common.AdministrativeState" + connectivity-service-end-point-id: + type: "string" + description: "UUID of the CSEP to be monitored: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + service-interface-point-id: + type: "string" + description: "UUID of the associated SIP to be monitored: An identifier that\ + \ is universally unique within an identifier space, where the identifier\ + \ space is itself globally unique, and immutable.\r\n \ + \ An UUID carries no semantics with respect to the purpose or state of\ + \ the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + oam-service-id: + type: "string" + description: "UUID of the parent OamService: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + uuid: type: "string" - description: "none" - tapi.oam.createoamserviceendpoint.Output: + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.createoamservicepoint.Output: type: "object" properties: - end-point: + oam-service-point: description: "none" - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" + $ref: "#/definitions/tapi.oam.oamservice.OamServicePoint" + tapi.oam.currentdata.HistoryData: + allOf: + - $ref: "#/definitions/tapi.eth.HistoryDataAugmentation1" + - $ref: "#/definitions/tapi.eth.HistoryDataAugmentation10" + - $ref: "#/definitions/tapi.eth.HistoryDataAugmentation11" + - $ref: "#/definitions/tapi.eth.HistoryDataAugmentation12" + - $ref: "#/definitions/tapi.eth.HistoryDataAugmentation2" + - $ref: "#/definitions/tapi.eth.HistoryDataAugmentation3" + - $ref: "#/definitions/tapi.eth.HistoryDataAugmentation4" + - $ref: "#/definitions/tapi.eth.HistoryDataAugmentation5" + - $ref: "#/definitions/tapi.eth.HistoryDataAugmentation6" + - $ref: "#/definitions/tapi.eth.HistoryDataAugmentation7" + - $ref: "#/definitions/tapi.eth.HistoryDataAugmentation8" + - $ref: "#/definitions/tapi.eth.HistoryDataAugmentation9" + - $ref: "#/definitions/tapi.oam.HistoryData" tapi.oam.deleteoamjob.Input: type: "object" properties: - job-id: + uuid: type: "string" - description: "none" - tapi.oam.deleteoamservice.Input: + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.deleteoamprofile.Input: type: "object" properties: - service-id: + uuid: type: "string" - description: "none" - tapi.oam.deleteoamserviceendpoint.Input: + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.deleteoamservice.Input: type: "object" properties: - service-id: + uuid: type: "string" - description: "none" - o-sep-id: + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.deleteoamservicepoint.Input: + type: "object" + properties: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.oam.getmeg.Input: type: "object" properties: - service-id: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.oam.getmeg.Output: type: "object" properties: meg: description: "none" - $ref: "#/definitions/tapi.oam.Meg" + $ref: "#/definitions/tapi.oam.getmeg.output.Meg" + tapi.oam.getmeg.output.Meg: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.common.OperationalStatePac" + - $ref: "#/definitions/tapi.eth.MegAugmentation1" + - type: "object" + properties: + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + mep: + type: "array" + description: "1. ME may have 0 MEPs (case of transit domains where at least\ + \ 1 MIP is present)\r\n 2. ME may have 1 MEP (case of edge\ + \ domaind, where the peer MEP is ouside the managed domain)\r\n \ + \ 3. ME may have 2 MEPs" + items: + $ref: "#/definitions/tapi.oam.meg.Mep" + mip: + type: "array" + description: "ME may 0, 1, or more MIPs" + items: + $ref: "#/definitions/tapi.oam.meg.Mip" + description: "none" tapi.oam.getoamjob.Input: type: "object" properties: - job-id: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.oam.getoamjob.Output: type: "object" properties: oam-job: description: "none" - $ref: "#/definitions/tapi.oam.OamJob" - tapi.oam.getoamservice.Input: + $ref: "#/definitions/tapi.oam.getoamjob.output.OamJob" + tapi.oam.getoamjob.output.OamJob: + allOf: + - $ref: "#/definitions/tapi.eth.OamJobAugmentation1" + - $ref: "#/definitions/tapi.eth.OamJobAugmentation2" + - $ref: "#/definitions/tapi.eth.OamJobAugmentation3" + - $ref: "#/definitions/tapi.eth.OamJobAugmentation4" + - $ref: "#/definitions/tapi.eth.OamJobAugmentation5" + - $ref: "#/definitions/tapi.eth.OamJobAugmentation6" + - $ref: "#/definitions/tapi.eth.OamJobAugmentation7" + - $ref: "#/definitions/tapi.oam.OamJob" + tapi.oam.getoamjoblist.Output: type: "object" properties: - service-id: - type: "string" + oam-job: + type: "array" description: "none" - tapi.oam.getoamservice.Output: + items: + $ref: "#/definitions/tapi.oam.getoamjob.output.OamJob" + tapi.oam.getoamprofile.Input: type: "object" properties: - service: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.getoamprofile.Output: + type: "object" + properties: + oam-profile: description: "none" - $ref: "#/definitions/tapi.oam.OamService" - tapi.oam.getoamserviceendpoint.Input: + $ref: "#/definitions/tapi.oam.OamProfile" + tapi.oam.getoamprofilelist.Output: type: "object" properties: - service-id: - type: "string" + oam-profile: + type: "array" description: "none" - o-sep-id: + items: + $ref: "#/definitions/tapi.oam.OamProfile" + tapi.oam.getoamservice.Input: + type: "object" + properties: + uuid: type: "string" - description: "none" - tapi.oam.getoamserviceendpoint.Output: + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.getoamservice.Output: type: "object" properties: - end-point: + oam-service: description: "none" - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" + $ref: "#/definitions/tapi.oam.getoamservice.output.OamService" + tapi.oam.getoamservice.output.OamService: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.eth.OamServiceAugmentation1" + - type: "object" + properties: + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + oam-service-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.oamservice.OamServicePoint" + meg: + description: "none" + $ref: "#/definitions/tapi.oam.MegRef" + description: "none" tapi.oam.getoamservicelist.Output: type: "object" properties: - service: + oam-service: type: "array" description: "none" items: - $ref: "#/definitions/tapi.oam.OamService" + $ref: "#/definitions/tapi.oam.getoamservicelist.output.OamService" + tapi.oam.getoamservicelist.output.OamService: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.eth.OamServiceAugmentation1" + - type: "object" + properties: + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + oam-service-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.oamservice.OamServicePoint" + meg: + description: "none" + $ref: "#/definitions/tapi.oam.MegRef" + description: "none" + tapi.oam.getoamservicepoint.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.getoamservicepoint.Output: + type: "object" + properties: + oam-service-point: + description: "none" + $ref: "#/definitions/tapi.oam.oamservice.OamServicePoint" tapi.oam.meg.Mep: allOf: - $ref: "#/definitions/tapi.eth.MepAugmentation1" @@ -23172,32 +24297,22 @@ definitions: - $ref: "#/definitions/tapi.eth.MegAugmentation1" - type: "object" properties: - meg-identifier: - type: "string" - description: "none" - meg-level: - type: "integer" - format: "int32" - description: "none" - mip: - type: "array" - description: "ME may 0, 1, or more MIPs" - items: - $ref: "#/definitions/tapi.oam.meg.Mip" layer-protocol-name: description: "none" $ref: "#/definitions/tapi.common.LayerProtocolName" mep: type: "array" description: "1. ME may have 0 MEPs (case of transit domains where at least\ - \ 1 MIP is present)\r\n 2. ME may have 1 MEP (case\ - \ of edge domaind, where the peer MEP is ouside the managed domain)\r\n\ - \ 3. ME may have 2 MEPs" + \ 1 MIP is present)\r\n 2. ME may have 1 MEP (case of edge\ + \ domaind, where the peer MEP is ouside the managed domain)\r\n \ + \ 3. ME may have 2 MEPs" items: $ref: "#/definitions/tapi.oam.meg.Mep" - direction: - description: "none" - $ref: "#/definitions/tapi.common.ForwardingDirection" + mip: + type: "array" + description: "ME may 0, 1, or more MIPs" + items: + $ref: "#/definitions/tapi.oam.meg.Mip" description: "none" tapi.oam.oamcontext.OamJob: allOf: @@ -23218,183 +24333,267 @@ definitions: oam-profile: description: "none" $ref: "#/definitions/tapi.oam.OamProfileRef" - pm-current-data: - type: "array" - description: "Granularity period of the CurrentData identifies the specific\ - \ CurrentData instance in the scope of this OamJob.\r\n \ - \ For example, typically at least\r\n one 15min\ - \ and\r\n one 24hr;\r\n optionally\ - \ one additional configurable (< 15min)" - items: - $ref: "#/definitions/tapi.oam.oamjob.PmCurrentData" creation-time: type: "string" description: "none" - oam-service-end-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamServiceEndPointRef" oam-job-type: type: "string" description: "none" + oam-service-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamServicePointRef" + current-data: + type: "array" + description: "Granularity period of the CurrentData identifies the specific\ + \ CurrentData instance in the scope of this OamJob.\r\n \ + \ For example, typically at least\r\n one 15min and\r\n\ + \ one 24hr;\r\n optionally one additional\ + \ configurable (< 15min)" + items: + $ref: "#/definitions/tapi.oam.oamjob.CurrentData" description: "none" - tapi.oam.oamcontext.OamProfile: + tapi.oam.oamcontext.OamService: allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.eth.OamServiceAugmentation1" - type: "object" properties: - pm-threshold-data: - type: "array" + layer-protocol-name: description: "none" - items: - $ref: "#/definitions/tapi.oam.oamprofile.PmThresholdData" - pm-bin-data: + $ref: "#/definitions/tapi.common.LayerProtocolName" + oam-service-point: type: "array" description: "none" items: - $ref: "#/definitions/tapi.oam.PmBinData" + $ref: "#/definitions/tapi.oam.oamservice.OamServicePoint" + meg: + description: "none" + $ref: "#/definitions/tapi.oam.MegRef" description: "none" - tapi.oam.oamjob.PmCurrentData: + tapi.oam.oamjob.CurrentData: allOf: - $ref: "#/definitions/tapi.common.LocalClass" - - $ref: "#/definitions/tapi.eth.PmCurrentDataAugmentation1" - - $ref: "#/definitions/tapi.eth.PmCurrentDataAugmentation10" - - $ref: "#/definitions/tapi.eth.PmCurrentDataAugmentation11" - - $ref: "#/definitions/tapi.eth.PmCurrentDataAugmentation2" - - $ref: "#/definitions/tapi.eth.PmCurrentDataAugmentation3" - - $ref: "#/definitions/tapi.eth.PmCurrentDataAugmentation4" - - $ref: "#/definitions/tapi.eth.PmCurrentDataAugmentation5" - - $ref: "#/definitions/tapi.eth.PmCurrentDataAugmentation6" - - $ref: "#/definitions/tapi.eth.PmCurrentDataAugmentation7" - - $ref: "#/definitions/tapi.eth.PmCurrentDataAugmentation8" - - $ref: "#/definitions/tapi.eth.PmCurrentDataAugmentation9" + - $ref: "#/definitions/tapi.eth.CurrentDataAugmentation1" + - $ref: "#/definitions/tapi.eth.CurrentDataAugmentation10" + - $ref: "#/definitions/tapi.eth.CurrentDataAugmentation11" + - $ref: "#/definitions/tapi.eth.CurrentDataAugmentation12" + - $ref: "#/definitions/tapi.eth.CurrentDataAugmentation13" + - $ref: "#/definitions/tapi.eth.CurrentDataAugmentation14" + - $ref: "#/definitions/tapi.eth.CurrentDataAugmentation15" + - $ref: "#/definitions/tapi.eth.CurrentDataAugmentation2" + - $ref: "#/definitions/tapi.eth.CurrentDataAugmentation3" + - $ref: "#/definitions/tapi.eth.CurrentDataAugmentation4" + - $ref: "#/definitions/tapi.eth.CurrentDataAugmentation5" + - $ref: "#/definitions/tapi.eth.CurrentDataAugmentation6" + - $ref: "#/definitions/tapi.eth.CurrentDataAugmentation7" + - $ref: "#/definitions/tapi.eth.CurrentDataAugmentation8" + - $ref: "#/definitions/tapi.eth.CurrentDataAugmentation9" - type: "object" properties: elapsed-time: description: "none" $ref: "#/definitions/tapi.common.TimeInterval" - pm-history-data: + period-start-time: + type: "string" + description: "This attribute indicates the start of the current monitoring\ + \ interval.\r\n The value is bound to the quarter of an\ + \ hour in case of a 15 minute interval and bound to the hour in case of\ + \ a 24 hour interval." + pm-data-pac: + description: "none" + $ref: "#/definitions/tapi.oam.PmDataPac" + history-data: type: "array" description: "in case of 24hr Current Data, at least 1 History Data.\r\n\ - \ In case of 15min Current Data, at least 16 History\ - \ Data.\r\n In case of <15min, the number of History\ - \ Data shall be able to cover a span of 4 hours." + \ In case of 15min Current Data, at least 16 History Data.\r\ + \n In case of <15min, the number of History Data shall\ + \ be able to cover a span of 4 hours." items: - $ref: "#/definitions/tapi.oam.pmcurrentdata.PmHistoryData" - granularity-period: - description: "none" - $ref: "#/definitions/tapi.common.TimePeriod" - suspect-interval-flag: - type: "boolean" - description: "This attribute is used to indicate that the performance data\ - \ for the current period may not be reliable. Some reasons for this to\ - \ occur are:\r\n Suspect data were detected by the\ - \ actual resource doing data collection.\r\n Transition\ - \ of the administrativeState attribute to/from the 'lock' state.\r\n \ - \ Transition of the operationalState to/from the 'disabled'\ - \ state.\r\n Scheduler setting that inhibits the\ - \ collection function.\r\n The performance counters\ - \ were reset during the interval.\r\n The currentData\ - \ (or subclass) object instance was created during the monitoring period." - default: false - timestamp: - type: "string" - description: "This attribute indicates the start of the current monitoring\ - \ interval.\r\n The value is bound to the quarter of\ - \ an hour in case of a 15 minute interval and bound to the hour in case\ - \ of a 24 hour interval." + $ref: "#/definitions/tapi.oam.currentdata.HistoryData" description: "Granularity period of the CurrentData identifies the specific\ - \ CurrentData instance in the scope of this OamJob.\r\n \ - \ For example, typically at least\r\n one 15min and\r\n\ - \ one 24hr;\r\n optionally one additional\ - \ configurable (< 15min)" - tapi.oam.oamprofile.PmThresholdData: + \ CurrentData instance in the scope of this OamJob.\r\n For\ + \ example, typically at least\r\n one 15min and\r\n \ + \ one 24hr;\r\n optionally one additional configurable\ + \ (< 15min)" + tapi.oam.oamservice.OamServicePoint: allOf: - - $ref: "#/definitions/tapi.eth.PmThresholdDataAugmentation1" - - $ref: "#/definitions/tapi.eth.PmThresholdDataAugmentation2" - - $ref: "#/definitions/tapi.eth.PmThresholdDataAugmentation3" - - $ref: "#/definitions/tapi.eth.PmThresholdDataAugmentation4" - - $ref: "#/definitions/tapi.oam.PmThresholdData" - tapi.oam.pmcurrentdata.PmHistoryData: - allOf: - - $ref: "#/definitions/tapi.eth.PmHistoryDataAugmentation1" - - $ref: "#/definitions/tapi.eth.PmHistoryDataAugmentation2" - - $ref: "#/definitions/tapi.eth.PmHistoryDataAugmentation3" - - $ref: "#/definitions/tapi.eth.PmHistoryDataAugmentation4" - - $ref: "#/definitions/tapi.eth.PmHistoryDataAugmentation5" - - $ref: "#/definitions/tapi.eth.PmHistoryDataAugmentation6" - - $ref: "#/definitions/tapi.eth.PmHistoryDataAugmentation7" - - $ref: "#/definitions/tapi.eth.PmHistoryDataAugmentation8" - - $ref: "#/definitions/tapi.oam.PmHistoryData" + - $ref: "#/definitions/tapi.eth.OamServicePointAugmentation1" + - $ref: "#/definitions/tapi.eth.OamServicePointAugmentation2" + - $ref: "#/definitions/tapi.oam.OamServicePoint" tapi.oam.updateoamjob.Input: + allOf: + - $ref: "#/definitions/tapi.eth.InputAugmentation1" + - $ref: "#/definitions/tapi.eth.InputAugmentation2" + - $ref: "#/definitions/tapi.eth.InputAugmentation3" + - $ref: "#/definitions/tapi.eth.InputAugmentation4" + - $ref: "#/definitions/tapi.eth.InputAugmentation5" + - $ref: "#/definitions/tapi.eth.InputAugmentation6" + - $ref: "#/definitions/tapi.eth.InputAugmentation7" + - type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but\ + \ may change during the life of the entity.\r\n A name\ + \ carries no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + schedule: + description: "none" + $ref: "#/definitions/tapi.common.TimeRange" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + oam-profile-id: + type: "string" + description: "UUID of the OamProfile to be applied: An identifier that is\ + \ universally unique within an identifier space, where the identifier\ + \ space is itself globally unique, and immutable.\r\n \ + \ An UUID carries no semantics with respect to the purpose or state\ + \ of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase\ + \ characters.\r\n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of\ + \ a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the\ + \ purpose or state of the entity.\r\n UUID here uses\ + \ string representation as defined in RFC 4122. The canonical representation\ + \ uses lowercase characters.\r\n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of\ + \ a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + description: "" + tapi.oam.updateoamjob.Output: type: "object" properties: - job-id: - type: "string" - description: "none" - schedule: - type: "string" - description: "none" - oam-profile: + oam-job: description: "none" - $ref: "#/definitions/tapi.oam.OamProfile" - state: + $ref: "#/definitions/tapi.oam.getoamjob.output.OamJob" + tapi.oam.updateoamprofile.Input: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + pm-threshold-data: + type: "array" description: "none" - tapi.oam.updateoamjob.Output: + items: + $ref: "#/definitions/tapi.oam.PmThresholdData" + tapi.oam.updateoamprofile.Output: type: "object" properties: - oam-job: + oam-profile: description: "none" - $ref: "#/definitions/tapi.oam.OamJob" + $ref: "#/definitions/tapi.oam.OamProfile" tapi.oam.updateoamservice.Input: type: "object" properties: - oam-constraint: - description: "none" - $ref: "#/definitions/tapi.oam.OamConstraint" - service-id: - type: "string" - description: "none" - state: - type: "string" - description: "none" - end-point: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + oam-service-point: type: "array" description: "none" items: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" + $ref: "#/definitions/tapi.oam.createoamservice.input.OamServicePoint" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.oam.updateoamservice.Output: type: "object" properties: - service: + oam-service: description: "none" - $ref: "#/definitions/tapi.oam.OamService" - tapi.oam.updateoamserviceendpoint.Input: + $ref: "#/definitions/tapi.oam.updateoamservice.output.OamService" + tapi.oam.updateoamservice.output.OamService: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.eth.OamServiceAugmentation1" + - type: "object" + properties: + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + oam-service-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.oamservice.OamServicePoint" + meg: + description: "none" + $ref: "#/definitions/tapi.oam.MegRef" + description: "none" + tapi.oam.updateoamservicepoint.Input: type: "object" properties: - service-id: - type: "string" - description: "none" - o-sep-id: - type: "string" - description: "none" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" state: - type: "string" description: "none" - tapi.oam.updateoamserviceendpoint.Output: + $ref: "#/definitions/tapi.common.AdministrativeState" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.updateoamservicepoint.Output: type: "object" properties: - end-point: + oam-service-point: description: "none" - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" + $ref: "#/definitions/tapi.oam.oamservice.OamServicePoint" tapi.path.computation.ComputeP2PPath: type: "object" properties: output: $ref: "#/definitions/tapi.path.computation.computep2ppath.Output" - tapi.path.computation.ContextAugmentation3: + tapi.path.computation.ContextAugmentation2: type: "object" properties: path-computation-context: @@ -23463,8 +24662,10 @@ definitions: - type: "object" properties: topology-constraint: + type: "array" description: "none" - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" path: type: "array" description: "none" @@ -23478,12 +24679,18 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" routing-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.RoutingConstraint" optimization-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" + direction: + description: "none" + $ref: "#/definitions/tapi.common.ForwardingDirection" description: "none" tapi.path.computation.PathObjectiveFunction: allOf: @@ -23548,16 +24755,16 @@ definitions: description: "none" $ref: "#/definitions/tapi.common.Capacity" description: "The association of the FC to LTPs is made via EndPoints.\r\n \ - \ The EndPoint (EP) object class models the access to the FC\ - \ function. \r\n The traffic forwarding between the associated\ - \ EPs of the FC depends upon the type of FC and may be associated with FcSwitch\ - \ object instances. \r\n In cases where there is resilience\ - \ the EndPoint may convey the resilience role of the access to the FC. \r\n\ - \ It can represent a protected (resilient/reliable) point or\ - \ a protecting (unreliable working or protection) point.\r\n \ - \ The EP replaces the Protection Unit of a traditional protection model.\ - \ \r\n The ForwadingConstruct can be considered as a component\ - \ and the EndPoint as a Port on that component" + \ The EndPoint (EP) object class models the access to the FC function.\ + \ \r\n The traffic forwarding between the associated EPs of the\ + \ FC depends upon the type of FC and may be associated with FcSwitch object\ + \ instances. \r\n In cases where there is resilience the EndPoint\ + \ may convey the resilience role of the access to the FC. \r\n \ + \ It can represent a protected (resilient/reliable) point or a protecting\ + \ (unreliable working or protection) point.\r\n The EP replaces\ + \ the Protection Unit of a traditional protection model. \r\n The\ + \ ForwadingConstruct can be considered as a component and the EndPoint as\ + \ a Port on that component" tapi.path.computation.RouteObjectiveFunction: type: "string" enum: @@ -23575,6 +24782,9 @@ definitions: type: "boolean" description: "To distinguish if the resources are to be exclusive to the service" default: true + tolerable-impact: + type: "string" + description: "Grades of maximum tolerable disruption to traffic." diversity-policy: description: "none" $ref: "#/definitions/tapi.path.computation.DiversityPolicy" @@ -23598,78 +24808,100 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.topology.RiskCharacteristic" - route-direction: - description: "none" - $ref: "#/definitions/tapi.common.ForwardingDirection" tapi.path.computation.TopologyConstraint: - type: "object" - properties: - include-node: - type: "array" - description: "This is a loose constraint - that is it is unordered and could\ - \ be a partial list" - items: - $ref: "#/definitions/tapi.topology.NodeRef" - exclude-link: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.LinkRef" - avoid-topology: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.TopologyRef" - exclude-path: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.path.computation.PathRef" - include-link: - type: "array" - description: "This is a loose constraint - that is it is unordered and could\ - \ be a partial list " - items: - $ref: "#/definitions/tapi.topology.LinkRef" - preferred-transport-layer: - type: "array" - description: "soft constraint requested by client to indicate the layer(s)\ - \ of transport connection that it prefers to carry the service. This could\ - \ be same as the service layer or one of the supported server layers" - items: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + include-node: + type: "string" + description: "This is a loose constraint - that is it is unordered and could\ + \ be a partial list" + exclude-link: + type: "string" + description: "none" + avoid-topology: + type: "string" + description: "none" + exclude-path: + type: "string" + description: "none" + include-topology: + type: "string" + description: "none" + include-path: + type: "string" + description: "none" + exclude-node-edge-point: + type: "string" + description: "none" + include-node-edge-point: + type: "string" + description: "none" + include-link: + type: "string" + description: "This is a loose constraint - that is it is unordered and could\ + \ be a partial list " + preferred-transport-layer: + description: "soft constraint requested by client to indicate the layer(s)\ + \ of transport connection that it prefers to carry the service. This could\ + \ be same as the service layer or one of the supported server layers" $ref: "#/definitions/tapi.common.LayerProtocolName" - exclude-node: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.NodeRef" - include-topology: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.TopologyRef" - include-path: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.path.computation.PathRef" + exclude-node: + type: "string" + description: "none" + constraint-weight: + type: "integer" + format: "int32" + description: "Zero and positive values: zero means 'strongly required to\ + \ be included', +1 means 'less strongly required to be included', etc.\r\ + \n For example the work/intended route will be calculated\ + \ considering the topologies which weights are lowest (but not negative).\r\ + \n Negative values: -1 means 'strongly required to be excluded',\ + \ -2 means 'less strongly required to be excluded', etc." + description: "The TopologyConstraint allows to specify topology entities in\ + \ order to impose specific constraints (as denoted by the attribute name)\ + \ on Connectivity/Path.\r\n The topology entities are specified\ + \ by their instance uuid rather than using references/path (to allow for mapping\ + \ to Yang 1.0).\r\n This loose typing and reference necessitates\ + \ that implementations validate not only the presence of the instance, but\ + \ also that it is of the correct type as implied by the attribute name.\r\n\ + \ If this validation fails, then the implementation is expceted\ + \ to return an error.\r\n " tapi.path.computation.computep2ppath.Input: type: "object" properties: topology-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - routing-constraint: + end-point: + type: "array" description: "none" - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + items: + $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" objective-function: description: "none" $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" - sep: + name: type: "array" - description: "none" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." items: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + $ref: "#/definitions/tapi.common.NameAndValue" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.path.computation.computep2ppath.Output: type: "object" properties: @@ -23679,9 +24911,16 @@ definitions: tapi.path.computation.deletep2ppath.Input: type: "object" properties: - path-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.path.computation.deletep2ppath.Output: type: "object" properties: @@ -23691,15 +24930,29 @@ definitions: tapi.path.computation.optimizep2ppath.Input: type: "object" properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" routing-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - path-id-or-name: - type: "string" - description: "none" optimization-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" objective-function: description: "none" $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" @@ -23795,7 +25048,7 @@ definitions: type: "string" description: "High frequency deviation from true periodicity of a signal and\ \ therefore a small high rate of change of transfer latency.\r\n \ - \ Applies to TDM systems (and not packet)." + \ Applies to TDM systems (and not packet)." fixed-latency-characteristic: type: "string" description: "A TopologicalEntity suffers delay caused by the realization\ @@ -23806,7 +25059,7 @@ definitions: type: "string" description: "Low frequency deviation from true periodicity of a signal and\ \ therefore a small low rate of change of transfer latency.\r\n \ - \ Applies to TDM systems (and not packet)." + \ Applies to TDM systems (and not packet)." queing-latency-characteristic: type: "string" description: "The specific queuing latency for the traffic property." @@ -23838,19 +25091,22 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.common.LayerProtocolName" - resilience-type: + restoration-policy: description: "none" - $ref: "#/definitions/tapi.topology.ResilienceType" + $ref: "#/definitions/tapi.topology.RestorationPolicy" node-edge-point: type: "array" description: "none" items: $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + protection-type: + description: "none" + $ref: "#/definitions/tapi.topology.ProtectionType" direction: - description: "The directionality of the Link. \r\n Is\ - \ applicable to simple Links where all LinkEnds are BIDIRECTIONAL (the\ - \ Link will be BIDIRECTIONAL) or UNIDIRECTIONAL (the Link will be UNIDIRECTIONAL).\ - \ \r\n Is not present in more complex cases." + description: "The directionality of the Link. \r\n Is applicable\ + \ to simple Links where all LinkEnds are BIDIRECTIONAL (the Link will\ + \ be BIDIRECTIONAL) or UNIDIRECTIONAL (the Link will be UNIDIRECTIONAL).\ + \ \r\n Is not present in more complex cases." $ref: "#/definitions/tapi.common.ForwardingDirection" description: "The Link object class models effective adjacency between two or\ \ more ForwardingDomains (FD). " @@ -23864,6 +25120,16 @@ definitions: description: "none" x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:link/tapi-topology:uuid" description: "none" + tapi.topology.NepLayerProtocolCapability: + type: "object" + properties: + layer-protocol-qualifier: + type: "string" + description: "none" + number-of-cep-instances: + type: "integer" + format: "int32" + description: "none" tapi.topology.NetworkTopologyService: allOf: - $ref: "#/definitions/tapi.common.GlobalClass" @@ -23893,16 +25159,16 @@ definitions: encap-topology: description: "none" $ref: "#/definitions/tapi.topology.TopologyRef" - owned-node-edge-point: + node-rule-group: type: "array" description: "none" items: - $ref: "#/definitions/tapi.topology.NodeEdgePoint" - node-rule-group: + $ref: "#/definitions/tapi.topology.NodeRuleGroup" + node-edge-point: type: "array" description: "none" items: - $ref: "#/definitions/tapi.topology.NodeRuleGroup" + $ref: "#/definitions/tapi.topology.NodeEdgePoint" aggregated-node-edge-point: type: "array" description: "none" @@ -23911,8 +25177,8 @@ definitions: description: "The ForwardingDomain (FD) object class models the ForwardingDomain\ \ topological component which is used to effect forwarding of transport characteristic\ \ information and offers the potential to enable forwarding. \r\n \ - \ At the lowest level of recursion, an FD (within a network element\ - \ (NE)) represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ + \ At the lowest level of recursion, an FD (within a network element (NE))\ + \ represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ \ multiple switch matrices (FDs). " tapi.topology.NodeEdgePoint: allOf: @@ -23934,6 +25200,11 @@ definitions: \ balancing/Resilience) should be considered experimental" items: $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + available-cep-layer-protocol: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NepLayerProtocolCapability" aggregated-node-edge-point: type: "array" description: "none" @@ -23945,14 +25216,9 @@ definitions: link-port-direction: description: "The orientation of defined flow at the LinkEnd." $ref: "#/definitions/tapi.common.PortDirection" - supported-cep-layer-protocol-qualifier: - type: "array" - description: "none" - items: - type: "string" description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ \ termination and adaptation functions of one or more transport layers. \r\ - \n The structure of LTP supports all transport protocols including\ + \n The structure of LTP supports all transport protocols including\ \ circuit and packet forms." tapi.topology.NodeEdgePointRef: allOf: @@ -23962,7 +25228,7 @@ definitions: node-edge-point-uuid: type: "string" description: "none" - x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:owned-node-edge-point/tapi-topology:uuid" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:node-edge-point/tapi-topology:uuid" description: "none" tapi.topology.NodeRef: allOf: @@ -24017,41 +25283,32 @@ definitions: tapi.topology.ProtectionType: type: "string" enum: - - "NO_PROTECTON" + - "NO_PROTECTION" - "ONE_PLUS_ONE_PROTECTION" - - "ONE_PLUS_ONE_PROTECTION_WITH_DYNAMIC_RESTORATION" - - "PERMANENT_ONE_PLUS_ONE_PROTECTION" - "ONE_FOR_ONE_PROTECTION" - - "DYNAMIC_RESTORATION" - - "PRE_COMPUTED_RESTORATION" - tapi.topology.ResilienceType: - type: "object" - properties: - restoration-policy: - description: "none" - $ref: "#/definitions/tapi.topology.RestorationPolicy" - protection-type: - description: "none" - $ref: "#/definitions/tapi.topology.ProtectionType" + - "ONE_FOR_N_PROTECTION" + - "M_FOR_N_PROTECTION" + - "ONE_FOR_ONE_BY_N" tapi.topology.RestorationPolicy: type: "string" enum: - "PER_DOMAIN_RESTORATION" - "END_TO_END_RESTORATION" - "NA" + - "DYNAMIC_RESTORATION" + - "PRE_COMPUTED_RESTORATION" tapi.topology.RiskCharacteristic: type: "object" properties: risk-characteristic-name: type: "string" description: "The name of the risk characteristic. The characteristic may\ - \ be related to a specific degree of closeness. \r\n \ - \ For example a particular characteristic may apply to failures that are\ - \ localized (e.g. to one side of a road) where as another characteristic\ - \ may relate to failures that have a broader impact (e.g. both sides of\ - \ a road that crosses a bridge).\r\n Depending upon the\ - \ importance of the traffic being routed different risk characteristics\ - \ will be evaluated." + \ be related to a specific degree of closeness. \r\n For\ + \ example a particular characteristic may apply to failures that are localized\ + \ (e.g. to one side of a road) where as another characteristic may relate\ + \ to failures that have a broader impact (e.g. both sides of a road that\ + \ crosses a bridge).\r\n Depending upon the importance of\ + \ the traffic being routed different risk characteristics will be evaluated." risk-identifier-list: type: "array" description: "A list of the identifiers of each physical/geographic unit (with\ @@ -24113,11 +25370,16 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.topology.Node" + boundary-node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" description: "The ForwardingDomain (FD) object class models the ForwardingDomain\ \ topological component which is used to effect forwarding of transport characteristic\ \ information and offers the potential to enable forwarding. \r\n \ - \ At the lowest level of recursion, an FD (within a network element\ - \ (NE)) represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ + \ At the lowest level of recursion, an FD (within a network element (NE))\ + \ represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ \ multiple switch matrices (FDs). " tapi.topology.TopologyContext: type: "object" @@ -24152,7 +25414,7 @@ definitions: error-characteristic: type: "string" description: "Describes the degree to which the signal propagated can be errored.\ - \ \r\n Applies to TDM systems as the errored signal will\ + \ \r\n Applies to TDM systems as the errored signal will\ \ be propagated and not packet as errored packets will be discarded." unavailable-time-characteristic: type: "string" @@ -24165,19 +25427,19 @@ definitions: delivery-order-characteristic: type: "string" description: "Describes the degree to which packets will be delivered out\ - \ of sequence.\r\n Does not apply to TDM as the TDM protocols\ + \ of sequence.\r\n Does not apply to TDM as the TDM protocols\ \ maintain strict order." repeat-delivery-characteristic: type: "string" description: "Primarily applies to packet systems where a packet may be delivered\ - \ more than once (in fault recovery for example). \r\n \ - \ It can also apply to TDM where several frames may be received twice\ - \ due to switching in a system with a large differential propagation delay." + \ more than once (in fault recovery for example). \r\n It\ + \ can also apply to TDM where several frames may be received twice due to\ + \ switching in a system with a large differential propagation delay." loss-characteristic: type: "string" description: "Describes the acceptable characteristic of lost packets where\ \ loss may result from discard due to errors or overflow.\r\n \ - \ Applies to packet systems and not TDM (as for TDM errored signals\ + \ Applies to packet systems and not TDM (as for TDM errored signals\ \ are propagated unless grossly errored and overflow/underflow turns into\ \ timing slips)." tapi.topology.TransferTimingPac: @@ -24214,12 +25476,27 @@ definitions: tapi.topology.getlinkdetails.Input: type: "object" properties: - link-id-or-name: + link-id: type: "string" - description: "none" - topology-id-or-name: - type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.topology.getlinkdetails.Output: type: "object" properties: @@ -24229,12 +25506,27 @@ definitions: tapi.topology.getnodedetails.Input: type: "object" properties: - node-id-or-name: - type: "string" - description: "none" - topology-id-or-name: - type: "string" - description: "none" + node-id: + type: "string" + description: "UUID of the Node: An identifier that is universally unique within\ + \ an identifier space, where the identifier space is itself globally unique,\ + \ and immutable.\r\n An UUID carries no semantics with\ + \ respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC 4122. The canonical\ + \ representation uses lowercase characters.\r\n Pattern:\ + \ [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\ + \ \r\n Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.topology.getnodedetails.Output: type: "object" properties: @@ -24244,15 +25536,37 @@ definitions: tapi.topology.getnodeedgepointdetails.Input: type: "object" properties: - ep-id-or-name: - type: "string" - description: "none" - node-id-or-name: - type: "string" - description: "none" - topology-id-or-name: + node-id: + type: "string" + description: "UUID of the parent Node: An identifier that is universally unique\ + \ within an identifier space, where the identifier space is itself globally\ + \ unique, and immutable.\r\n An UUID carries no semantics\ + \ with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC 4122. The\ + \ canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\ + \ \r\n Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Node's Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + node-edge-point-id: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.topology.getnodeedgepointdetails.Output: type: "object" properties: @@ -24262,9 +25576,16 @@ definitions: tapi.topology.gettopologydetails.Input: type: "object" properties: - topology-id-or-name: + topology-id: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.topology.gettopologydetails.Output: type: "object" properties: @@ -24279,9 +25600,9 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.topology.Topology" - tapi.topology.node.OwnedNodeEdgePoint: + tapi.topology.node.NodeEdgePoint: allOf: - - $ref: "#/definitions/tapi.connectivity.OwnedNodeEdgePointAugmentation1" + - $ref: "#/definitions/tapi.connectivity.NodeEdgePointAugmentation1" - $ref: "#/definitions/tapi.topology.NodeEdgePoint" tapi.topology.topology.Node: allOf: @@ -24301,16 +25622,16 @@ definitions: encap-topology: description: "none" $ref: "#/definitions/tapi.topology.TopologyRef" - owned-node-edge-point: + node-rule-group: type: "array" description: "none" items: - $ref: "#/definitions/tapi.topology.node.OwnedNodeEdgePoint" - node-rule-group: + $ref: "#/definitions/tapi.topology.NodeRuleGroup" + node-edge-point: type: "array" description: "none" items: - $ref: "#/definitions/tapi.topology.NodeRuleGroup" + $ref: "#/definitions/tapi.topology.node.NodeEdgePoint" aggregated-node-edge-point: type: "array" description: "none" diff --git a/OAS/tapi-notification@2018-12-10.yaml b/OAS/tapi-notification@2019-03-31.yaml similarity index 64% rename from OAS/tapi-notification@2018-12-10.yaml rename to OAS/tapi-notification@2019-03-31.yaml index 444643b3..0e3c6545 100644 --- a/OAS/tapi-notification@2018-12-10.yaml +++ b/OAS/tapi-notification@2019-03-31.yaml @@ -1,8 +1,40 @@ --- swagger: "2.0" info: - description: "tapi-notification,tapi-common API generated from yang definitions" - version: "1.0" + description: "\r\n This module contains TAPI Notification Model definitions.\r\ + \n Source: TapiNotification.uml\r\n Copyright (c) 2018 Open Networking\ + \ Foundation (ONF). All rights reserved.\r\n License: This module is distributed\ + \ under the Apache License 2.0\r\n - The TAPI YANG models included in this\ + \ TAPI release are a *normative* part of the TAPI SDK.\r\n - The YANG specifications\ + \ have been generated from the corresponding UML model using the [ONF EAGLE UML2YANG\ + \ mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Common Model\ + \ definitions.\r\n Source: TapiCommon.uml\r\n Copyright (c) 2018\ + \ Open Networking Foundation (ONF). All rights reserved.\r\n License: This\ + \ module is distributed under the Apache License 2.0\r\n - The TAPI YANG\ + \ models included in this TAPI release are a *normative* part of the TAPI SDK.\r\ + \n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases." + version: "2.2.0" title: "tapi-notification,tapi-common API" host: "localhost:1234" consumes: @@ -14,7 +46,8 @@ paths: get: tags: - "tapi-common" - description: "returns tapi.common.Context" + summary: "returns tapi.common.Context" + description: "none" parameters: [] responses: 200: @@ -26,7 +59,8 @@ paths: post: tags: - "tapi-common" - description: "creates tapi.common.Context" + summary: "creates tapi.common.Context" + description: "none" parameters: - in: "body" name: "tapi.common.Context.body-param" @@ -44,7 +78,8 @@ paths: put: tags: - "tapi-common" - description: "creates or updates tapi.common.Context" + summary: "creates or updates tapi.common.Context" + description: "none" parameters: - in: "body" name: "tapi.common.Context.body-param" @@ -62,7 +97,8 @@ paths: delete: tags: - "tapi-common" - description: "removes tapi.common.Context" + summary: "removes tapi.common.Context" + description: "none" parameters: [] responses: 400: @@ -73,7 +109,10 @@ paths: post: tags: - "tapi-common" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - in: "body" name: "tapi.common.NameAndValue.body-param" @@ -92,7 +131,10 @@ paths: get: tags: - "tapi-common" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "value-name" in: "path" @@ -106,33 +148,13 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-common" - description: "creates or updates tapi.common.NameAndValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "value-name" in: "path" @@ -155,7 +177,10 @@ paths: delete: tags: - "tapi-common" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "value-name" in: "path" @@ -171,7 +196,8 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.notification.NotificationContext" + summary: "returns tapi.notification.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" parameters: [] responses: 200: @@ -183,7 +209,8 @@ paths: post: tags: - "tapi-notification" - description: "creates tapi.notification.NotificationContext" + summary: "creates tapi.notification.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" parameters: - in: "body" name: "tapi.notification.NotificationContext.body-param" @@ -201,7 +228,8 @@ paths: put: tags: - "tapi-notification" - description: "creates or updates tapi.notification.NotificationContext" + summary: "creates or updates tapi.notification.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" parameters: - in: "body" name: "tapi.notification.NotificationContext.body-param" @@ -219,7 +247,8 @@ paths: delete: tags: - "tapi-notification" - description: "removes tapi.notification.NotificationContext" + summary: "removes tapi.notification.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" parameters: [] responses: 400: @@ -230,7 +259,8 @@ paths: post: tags: - "tapi-notification" - description: "creates tapi.notification.NotificationSubscriptionService" + summary: "creates tapi.notification.NotificationSubscriptionService" + description: "none" parameters: - in: "body" name: "tapi.notification.NotificationSubscriptionService.body-param" @@ -250,7 +280,8 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.notification.NotificationSubscriptionService" + summary: "returns tapi.notification.NotificationSubscriptionService" + description: "none" parameters: - name: "uuid" in: "path" @@ -264,34 +295,11 @@ paths: $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" 400: description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationSubscriptionService" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationSubscriptionService.body-param" - description: "tapi.notification.NotificationSubscriptionService to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-notification" - description: "creates or updates tapi.notification.NotificationSubscriptionService" + summary: "creates or updates tapi.notification.NotificationSubscriptionService" + description: "none" parameters: - name: "uuid" in: "path" @@ -315,7 +323,8 @@ paths: delete: tags: - "tapi-notification" - description: "removes tapi.notification.NotificationSubscriptionService" + summary: "removes tapi.notification.NotificationSubscriptionService" + description: "none" parameters: - name: "uuid" in: "path" @@ -331,7 +340,10 @@ paths: post: tags: - "tapi-notification" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -355,7 +367,10 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -374,38 +389,13 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -433,7 +423,10 @@ paths: delete: tags: - "tapi-notification" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -454,7 +447,8 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.notification.NotificationChannel" + summary: "returns tapi.notification.NotificationChannel" + description: "none" parameters: - name: "uuid" in: "path" @@ -468,96 +462,14 @@ paths: $ref: "#/definitions/tapi.notification.NotificationChannel" 400: description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationChannel.body-param" - description: "tapi.notification.NotificationChannel to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationChannel.body-param" - description: "tapi.notification.NotificationChannel to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/notification-channel/name/: - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" /data/context/notification-context/notif-subscription={uuid}/notification-channel/name={value-name}/: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -576,87 +488,12 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/: get: tags: - "tapi-notification" - description: "returns tapi.notification.Notification" + summary: "returns tapi.notification.Notification" + description: "none" parameters: - name: "uuid" in: "path" @@ -679,7 +516,8 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -703,34 +541,12 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/alarm-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.AlarmInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.AlarmInfo" - schema: - $ref: "#/definitions/tapi.notification.AlarmInfo" - 400: - description: "Internal error" /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/changed-attributes={value-name}/: get: tags: - "tapi-notification" - description: "returns tapi.notification.NameAndValueChange" + summary: "returns tapi.notification.NameAndValueChange" + description: "none" parameters: - name: "uuid" in: "path" @@ -758,7 +574,10 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -786,7 +605,8 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -810,34 +630,12 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/tca-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.TcaInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.TcaInfo" - schema: - $ref: "#/definitions/tapi.notification.TcaInfo" - 400: - description: "Internal error" /data/context/notification-context/notif-subscription={uuid}/subscription-filter/: get: tags: - "tapi-notification" - description: "returns tapi.notification.SubscriptionFilter" + summary: "returns tapi.notification.SubscriptionFilter" + description: "none" parameters: - name: "uuid" in: "path" @@ -854,7 +652,8 @@ paths: post: tags: - "tapi-notification" - description: "creates tapi.notification.SubscriptionFilter" + summary: "creates tapi.notification.SubscriptionFilter" + description: "none" parameters: - name: "uuid" in: "path" @@ -877,7 +676,8 @@ paths: put: tags: - "tapi-notification" - description: "creates or updates tapi.notification.SubscriptionFilter" + summary: "creates or updates tapi.notification.SubscriptionFilter" + description: "none" parameters: - name: "uuid" in: "path" @@ -900,7 +700,8 @@ paths: delete: tags: - "tapi-notification" - description: "removes tapi.notification.SubscriptionFilter" + summary: "removes tapi.notification.SubscriptionFilter" + description: "none" parameters: - name: "uuid" in: "path" @@ -916,7 +717,10 @@ paths: post: tags: - "tapi-notification" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -940,7 +744,10 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -959,38 +766,13 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -1018,7 +800,10 @@ paths: delete: tags: - "tapi-notification" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -1039,7 +824,8 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.notification.Notification" + summary: "returns tapi.notification.Notification" + description: "none" parameters: - name: "uuid" in: "path" @@ -1057,7 +843,8 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -1076,29 +863,12 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/notification-context/notification={uuid}/alarm-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.AlarmInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.AlarmInfo" - schema: - $ref: "#/definitions/tapi.notification.AlarmInfo" - 400: - description: "Internal error" /data/context/notification-context/notification={uuid}/changed-attributes={value-name}/: get: tags: - "tapi-notification" - description: "returns tapi.notification.NameAndValueChange" + summary: "returns tapi.notification.NameAndValueChange" + description: "none" parameters: - name: "uuid" in: "path" @@ -1121,7 +891,10 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -1144,7 +917,8 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -1163,29 +937,12 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/notification-context/notification={uuid}/tca-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.TcaInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.TcaInfo" - schema: - $ref: "#/definitions/tapi.notification.TcaInfo" - 400: - description: "Internal error" /data/context/service-interface-point/: post: tags: - "tapi-common" - description: "creates tapi.common.ServiceInterfacePoint" + summary: "creates tapi.common.ServiceInterfacePoint" + description: "none" parameters: - in: "body" name: "tapi.common.ServiceInterfacePoint.body-param" @@ -1204,7 +961,8 @@ paths: get: tags: - "tapi-common" - description: "returns tapi.common.ServiceInterfacePoint" + summary: "returns tapi.common.ServiceInterfacePoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -1218,33 +976,11 @@ paths: $ref: "#/definitions/tapi.common.ServiceInterfacePoint" 400: description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.ServiceInterfacePoint.body-param" - description: "tapi.common.ServiceInterfacePoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-common" - description: "creates or updates tapi.common.ServiceInterfacePoint" + summary: "creates or updates tapi.common.ServiceInterfacePoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -1256,106 +992,19 @@ paths: description: "tapi.common.ServiceInterfacePoint to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/service-interface-point={uuid}/available-capacity/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/committed-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + responses: + 201: + description: "Object created" 400: description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/peak-burst-size/: - get: + 204: + description: "Object modified" + delete: tags: - "tapi-common" - description: "returns tapi.common.CapacityValue" + summary: "removes tapi.common.ServiceInterfacePoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -1363,17 +1012,16 @@ paths: required: true type: "string" responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/peak-information-rate/: + 204: + description: "Object deleted" + /data/context/service-interface-point={uuid}/available-capacity/: get: tags: - "tapi-common" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" @@ -1382,16 +1030,18 @@ paths: type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" /data/context/service-interface-point={uuid}/available-capacity/total-size/: get: tags: - "tapi-common" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -1409,7 +1059,10 @@ paths: post: tags: - "tapi-common" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -1433,7 +1086,10 @@ paths: get: tags: - "tapi-common" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -1452,38 +1108,13 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-common" - description: "creates or updates tapi.common.NameAndValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -1511,7 +1142,10 @@ paths: delete: tags: - "tapi-common" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -1532,7 +1166,9 @@ paths: get: tags: - "tapi-common" - description: "returns tapi.common.Capacity" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" @@ -1546,101 +1182,13 @@ paths: $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" /data/context/service-interface-point={uuid}/total-potential-capacity/total-size/: get: tags: - "tapi-common" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -1658,6 +1206,8 @@ paths: post: tags: - "tapi-notification" + summary: "operates on tapi.notification.CreateNotificationSubscriptionService" + description: "operates on tapi.notification.CreateNotificationSubscriptionService" parameters: - in: "body" name: "tapi.notification.createnotificationsubscriptionservice.Input.body-param" @@ -1679,6 +1229,8 @@ paths: post: tags: - "tapi-notification" + summary: "operates on tapi.notification.DeleteNotificationSubscriptionService" + description: "operates on tapi.notification.DeleteNotificationSubscriptionService" parameters: - in: "body" name: "tapi.notification.deletenotificationsubscriptionservice.Input.body-param" @@ -1688,10 +1240,6 @@ paths: input: $ref: "#/definitions/tapi.notification.deletenotificationsubscriptionservice.Input" responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.DeleteNotificationSubscriptionService" 201: description: "No response" 400: @@ -1700,6 +1248,8 @@ paths: post: tags: - "tapi-notification" + summary: "operates on tapi.notification.GetNotificationList" + description: "operates on tapi.notification.GetNotificationList" parameters: - in: "body" name: "tapi.notification.getnotificationlist.Input.body-param" @@ -1721,6 +1271,8 @@ paths: post: tags: - "tapi-notification" + summary: "operates on tapi.notification.GetNotificationSubscriptionServiceDetails" + description: "operates on tapi.notification.GetNotificationSubscriptionServiceDetails" parameters: - in: "body" name: "tapi.notification.getnotificationsubscriptionservicedetails.Input.body-param" @@ -1756,6 +1308,8 @@ paths: post: tags: - "tapi-common" + summary: "operates on tapi.common.GetServiceInterfacePointDetails" + description: "operates on tapi.common.GetServiceInterfacePointDetails" parameters: - in: "body" name: "tapi.common.getserviceinterfacepointdetails.Input.body-param" @@ -1805,6 +1359,8 @@ paths: post: tags: - "tapi-notification" + summary: "operates on tapi.notification.UpdateNotificationSubscriptionService" + description: "operates on tapi.notification.UpdateNotificationSubscriptionService" parameters: - in: "body" name: "tapi.notification.updatenotificationsubscriptionservice.Input.body-param" @@ -1826,6 +1382,8 @@ paths: post: tags: - "tapi-common" + summary: "operates on tapi.common.UpdateServiceInterfacePoint" + description: "operates on tapi.common.UpdateServiceInterfacePoint" parameters: - in: "body" name: "tapi.common.updateserviceinterfacepoint.Input.body-param" @@ -1857,45 +1415,9 @@ definitions: enum: - "LOCKED" - "UNLOCKED" - tapi.common.BandwidthProfile: - type: "object" - properties: - committed-information-rate: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - coupling-flag: - type: "boolean" - description: "none" - default: false - bw-profile-type: - description: "none" - $ref: "#/definitions/tapi.common.BandwidthProfileType" - peak-information-rate: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - committed-burst-size: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - peak-burst-size: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - color-aware: - type: "boolean" - description: "none" - default: false - tapi.common.BandwidthProfileType: - type: "string" - enum: - - "MEF_10.x" - - "RFC_2697" - - "RFC_2698" - - "RFC_4115" tapi.common.Capacity: type: "object" properties: - bandwidth-profile: - description: "none" - $ref: "#/definitions/tapi.common.BandwidthProfile" total-size: description: "Total capacity of the TopologicalEntity in MB/s. In case of\ \ bandwidthProfile, this is expected to same as the committedInformationRate." @@ -1952,21 +1474,21 @@ definitions: properties: name: type: "array" - description: "List of names. A property of an entity with a value that is\ - \ unique in some namespace but may change during the life of the entity.\ - \ A name carries no semantics with respect to the purpose of the entity." + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." items: $ref: "#/definitions/tapi.common.NameAndValue" uuid: type: "string" description: "UUID: An identifier that is universally unique within an identifier\ - \ space, where the identifier space is itself globally unique, and immutable.\ - \ An UUID carries no semantics with respect to the purpose or state of the\ - \ entity.\r\n UUID here uses string representation as\ - \ defined in RFC 4122. The canonical representation uses lowercase characters.\r\ - \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ - \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ - \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a UUID\ + \ in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.common.LayerProtocolName: type: "string" enum: @@ -1987,9 +1509,9 @@ definitions: properties: name: type: "array" - description: "List of names. A property of an entity with a value that is\ - \ unique in some namespace but may change during the life of the entity.\ - \ A name carries no semantics with respect to the purpose of the entity." + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." items: $ref: "#/definitions/tapi.common.NameAndValue" local-id: @@ -2027,7 +1549,7 @@ definitions: $ref: "#/definitions/tapi.common.LayerProtocolName" description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ \ termination and adaptation functions of one or more transport layers. \r\ - \n The structure of LTP supports all transport protocols including\ + \n The structure of LTP supports all transport protocols including\ \ circuit and packet forms." tapi.common.TapiContext: allOf: @@ -2043,12 +1565,28 @@ definitions: \ of control that a particular SDN controller has with respect to a particular\ \ network, (i.e., encompassing a designated set of interconnected (virtual)\ \ network elements)." - tapi.common.getserviceinterfacepointdetails.Input: + tapi.common.TimeRange: type: "object" properties: - sip-id-or-name: + end-time: type: "string" description: "none" + start-time: + type: "string" + description: "none" + tapi.common.getserviceinterfacepointdetails.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.common.getserviceinterfacepointdetails.Output: type: "object" properties: @@ -2066,28 +1604,19 @@ definitions: tapi.common.updateserviceinterfacepoint.Input: type: "object" properties: - sip-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" state: description: "none" $ref: "#/definitions/tapi.common.AdministrativeState" - tapi.notification.AlarmInfo: - type: "object" - properties: - perceived-severity: - description: "none" - $ref: "#/definitions/tapi.notification.PerceivedSeverityType" - probable-cause: - type: "string" - description: "none" - service-affecting: - description: "none" - $ref: "#/definitions/tapi.notification.ServiceAffecting" - is-transient: - type: "boolean" - description: "none" - default: false tapi.notification.ContextAugmentation1: type: "object" properties: @@ -2102,11 +1631,6 @@ definitions: properties: output: $ref: "#/definitions/tapi.notification.createnotificationsubscriptionservice.Output" - tapi.notification.DeleteNotificationSubscriptionService: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.notification.deletenotificationsubscriptionservice.Output" tapi.notification.GetNotificationList: type: "object" properties: @@ -2145,8 +1669,8 @@ definitions: - type: "object" properties: target-object-type: + type: "string" description: "none" - $ref: "#/definitions/tapi.notification.ObjectType" additional-text: type: "string" description: "none" @@ -2162,18 +1686,15 @@ definitions: type: "integer" format: "int32" description: "A monotonous increasing sequence number associated with the\ - \ notification.\r\n The exact semantics of how this\ - \ sequence number is assigned (per channel or subscription or source or\ - \ system) is left undefined." - tca-info: - description: "none" - $ref: "#/definitions/tapi.notification.TcaInfo" + \ notification.\r\n The exact semantics of how this sequence\ + \ number is assigned (per channel or subscription or source or system)\ + \ is left undefined." target-object-identifier: type: "string" description: "none" notification-type: + type: "string" description: "none" - $ref: "#/definitions/tapi.notification.NotificationType" target-object-name: type: "array" description: "none" @@ -2185,9 +1706,9 @@ definitions: source-indicator: description: "none" $ref: "#/definitions/tapi.notification.SourceIndicator" - alarm-info: + layer-protocol-qualifier: + type: "string" description: "none" - $ref: "#/definitions/tapi.notification.AlarmInfo" changed-attributes: type: "array" description: "none" @@ -2207,9 +1728,9 @@ definitions: stream-address: type: "string" description: "The address/location/URI of the channel/stream to which the\ - \ subscribed notifications are published.\r\n This\ - \ specifics of this is typically dependent on the implementation protocol\ - \ & mechanism and hence is typed as a string." + \ subscribed notifications are published.\r\n This specifics\ + \ of this is typically dependent on the implementation protocol & mechanism\ + \ and hence is typed as a string." description: "none" tapi.notification.NotificationContext: type: "object" @@ -2244,68 +1765,16 @@ definitions: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.ObjectType" + type: "string" supported-notification-types: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.NotificationType" + type: "string" subscription-filter: description: "none" $ref: "#/definitions/tapi.notification.SubscriptionFilter" description: "none" - tapi.notification.NotificationType: - type: "string" - enum: - - "OBJECT_CREATION" - - "OBJECT_DELETION" - - "ATTRIBUTE_VALUE_CHANGE" - - "ALARM_EVENT" - - "THRESHOLD_CROSSING_ALERT" - tapi.notification.ObjectType: - type: "string" - enum: - - "TOPOLOGY" - - "NODE" - - "LINK" - - "CONNECTION" - - "PATH" - - "CONNECTIVITY_SERVICE" - - "VIRTUAL_NETWORK_SERVICE" - - "PATH_COMPUTATION_SERVICE" - - "NODE_EDGE_POINT" - - "SERVICE_INTERFACE_POINT" - - "CONNECTION_END_POINT" - - "MAINTENANCE_ENTITY_GROUP" - - "MAINTENANCE_ENTITY" - - "MEG_END_POINT" - - "MEG_INTERMEDIATE_POINT" - - "SWITCH_CONTROL" - - "SWITCH" - - "ROUTE" - - "NODE_RULE_GROUP" - - "INTER_RULE_GROUP" - - "RULE" - - "OAM_JOB" - tapi.notification.PerceivedSeverityType: - type: "string" - enum: - - "CRITICAL" - - "MAJOR" - - "MINOR" - - "WARNING" - - "CLEARED" - tapi.notification.PerceivedTcaSeverity: - type: "string" - enum: - - "WARNING" - - "CLEAR" - tapi.notification.ServiceAffecting: - type: "string" - enum: - - "SERVICE_AFFECTING" - - "NOT_SERVICE_AFFECTING" - - "UNKNOWN" tapi.notification.SourceIndicator: type: "string" enum: @@ -2321,7 +1790,7 @@ definitions: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.NotificationType" + type: "string" requested-object-identifier: type: "array" description: "none" @@ -2342,46 +1811,13 @@ definitions: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.ObjectType" + type: "string" description: "none" tapi.notification.SubscriptionState: type: "string" enum: - "SUSPENDED" - "ACTIVE" - tapi.notification.TcaInfo: - type: "object" - properties: - threshold-crossing: - description: "none" - $ref: "#/definitions/tapi.notification.ThresholdCrossingType" - threshold-parameter: - type: "string" - description: "none" - is-transient: - type: "boolean" - description: "none" - default: false - threshold-value: - type: "integer" - format: "int32" - description: "none" - perceived-severity: - description: "none" - $ref: "#/definitions/tapi.notification.PerceivedTcaSeverity" - suspect-interval-flag: - type: "boolean" - description: "none" - default: false - measurement-interval: - type: "string" - description: "none" - tapi.notification.ThresholdCrossingType: - type: "string" - enum: - - "THRESHOLD_ABOVE" - - "THRESHOLD_BELOW" - - "CLEARED" tapi.notification.UpdateNotificationSubscriptionService: type: "object" properties: @@ -2393,6 +1829,23 @@ definitions: subscription-state: description: "none" $ref: "#/definitions/tapi.notification.SubscriptionState" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" subscription-filter: description: "none" $ref: "#/definitions/tapi.notification.SubscriptionFilter" @@ -2405,24 +1858,33 @@ definitions: tapi.notification.deletenotificationsubscriptionservice.Input: type: "object" properties: - subscription-id-or-name: + uuid: type: "string" - description: "none" - tapi.notification.deletenotificationsubscriptionservice.Output: - type: "object" - properties: - subscription-service: - description: "none" - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.notification.getnotificationlist.Input: type: "object" properties: - time-period: - type: "string" - description: "none" - subscription-id-or-name: - type: "string" + time-range: description: "none" + $ref: "#/definitions/tapi.common.TimeRange" + subscription-id: + type: "string" + description: "UUID of the associated Notification Subscription Service: An\ + \ identifier that is universally unique within an identifier space, where\ + \ the identifier space is itself globally unique, and immutable.\r\n \ + \ An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.notification.getnotificationlist.Output: type: "object" properties: @@ -2434,9 +1896,16 @@ definitions: tapi.notification.getnotificationsubscriptionservicedetails.Input: type: "object" properties: - subscription-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.notification.getnotificationsubscriptionservicedetails.Output: type: "object" properties: @@ -2458,24 +1927,38 @@ definitions: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.ObjectType" + type: "string" supported-notification-types: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.NotificationType" + type: "string" tapi.notification.updatenotificationsubscriptionservice.Input: type: "object" properties: subscription-state: description: "none" $ref: "#/definitions/tapi.notification.SubscriptionState" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" subscription-filter: description: "none" $ref: "#/definitions/tapi.notification.SubscriptionFilter" - subscription-id-or-name: - type: "string" - description: "none" tapi.notification.updatenotificationsubscriptionservice.Output: type: "object" properties: diff --git a/OAS/tapi-dsr@2018-12-10.yaml b/OAS/tapi-oam@2019-03-31.yaml similarity index 68% rename from OAS/tapi-dsr@2018-12-10.yaml rename to OAS/tapi-oam@2019-03-31.yaml index 7e0c3441..da05ae98 100644 --- a/OAS/tapi-dsr@2018-12-10.yaml +++ b/OAS/tapi-oam@2019-03-31.yaml @@ -1,10 +1,105 @@ --- swagger: "2.0" info: - description: "tapi-oam,tapi-path-computation,tapi-connectivity,tapi-dsr,tapi-notification,tapi-topology,tapi-common\ - \ API generated from yang definitions" - version: "1.0" - title: "tapi-oam,tapi-path-computation,tapi-connectivity,tapi-dsr,tapi-notification,tapi-topology,tapi-common\ + description: "\r\n This module contains TAPI Notification Model definitions.\r\ + \n Source: TapiNotification.uml\r\n Copyright (c) 2018 Open Networking\ + \ Foundation (ONF). All rights reserved.\r\n License: This module is distributed\ + \ under the Apache License 2.0\r\n - The TAPI YANG models included in this\ + \ TAPI release are a *normative* part of the TAPI SDK.\r\n - The YANG specifications\ + \ have been generated from the corresponding UML model using the [ONF EAGLE UML2YANG\ + \ mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Topology\ + \ Model definitions.\r\n Source: TapiTopology.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Common Model\ + \ definitions.\r\n Source: TapiCommon.uml\r\n Copyright (c) 2018\ + \ Open Networking Foundation (ONF). All rights reserved.\r\n License: This\ + \ module is distributed under the Apache License 2.0\r\n - The TAPI YANG\ + \ models included in this TAPI release are a *normative* part of the TAPI SDK.\r\ + \n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Path Computation\ + \ Model definitions.\r\n Source: TapiPathComputation.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Connectivity\ + \ Model definitions.\r\n Source: TapiConnectivity.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI OAM Model\ + \ definitions.\r\n Source: TapiOam.uml\r\n Copyright (c) 2018 Open\ + \ Networking Foundation (ONF). All rights reserved.\r\n License: This module\ + \ is distributed under the Apache License 2.0\r\n - The TAPI YANG models\ + \ included in this TAPI release are a *normative* part of the TAPI SDK.\r\n \ + \ - The YANG specifications have been generated from the corresponding UML\ + \ model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases." + version: "2.2.0" + title: "tapi-notification,tapi-topology,tapi-common,tapi-path-computation,tapi-connectivity,tapi-oam\ \ API" host: "localhost:1234" consumes: @@ -16,7 +111,8 @@ paths: get: tags: - "tapi-common" - description: "returns tapi.common.Context" + summary: "returns tapi.common.Context" + description: "none" parameters: [] responses: 200: @@ -28,7 +124,8 @@ paths: post: tags: - "tapi-common" - description: "creates tapi.common.Context" + summary: "creates tapi.common.Context" + description: "none" parameters: - in: "body" name: "tapi.common.Context.body-param" @@ -46,7 +143,8 @@ paths: put: tags: - "tapi-common" - description: "creates or updates tapi.common.Context" + summary: "creates or updates tapi.common.Context" + description: "none" parameters: - in: "body" name: "tapi.common.Context.body-param" @@ -64,7 +162,8 @@ paths: delete: tags: - "tapi-common" - description: "removes tapi.common.Context" + summary: "removes tapi.common.Context" + description: "none" parameters: [] responses: 400: @@ -75,7 +174,8 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityContext" + summary: "returns tapi.connectivity.ConnectivityContext" + description: "Augments the base TAPI Context with ConnectivityService information" parameters: [] responses: 200: @@ -87,7 +187,8 @@ paths: post: tags: - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityContext" + summary: "creates tapi.connectivity.ConnectivityContext" + description: "Augments the base TAPI Context with ConnectivityService information" parameters: - in: "body" name: "tapi.connectivity.ConnectivityContext.body-param" @@ -105,7 +206,8 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityContext" + summary: "creates or updates tapi.connectivity.ConnectivityContext" + description: "Augments the base TAPI Context with ConnectivityService information" parameters: - in: "body" name: "tapi.connectivity.ConnectivityContext.body-param" @@ -123,7 +225,8 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityContext" + summary: "removes tapi.connectivity.ConnectivityContext" + description: "Augments the base TAPI Context with ConnectivityService information" parameters: [] responses: 400: @@ -134,7 +237,8 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.Connection" + summary: "returns tapi.connectivity.Connection" + description: "none" parameters: - name: "uuid" in: "path" @@ -148,11 +252,31 @@ paths: $ref: "#/definitions/tapi.connectivity.Connection" 400: description: "Internal error" + /data/context/connectivity-context/connection={uuid}/bounding-node/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.topology.NodeRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connection" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeRef" + schema: + $ref: "#/definitions/tapi.topology.NodeRef" + 400: + description: "Internal error" ? /data/context/connectivity-context/connection={uuid}/connection-end-point={topology-uuid},{node-uuid},{node-edge-point-uuid},{connection-end-point-uuid}/ : get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionEndPointRef" + summary: "returns tapi.connectivity.ConnectionEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -190,7 +314,14 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionRef" + summary: "returns tapi.connectivity.ConnectionRef" + description: "An Connection object supports a recursive aggregation relationship\ + \ such that the internal construction of an Connection can be exposed as multiple\ + \ lower level Connection objects (partitioning).\r\n Aggregation\ + \ is used as for the Node/Topology to allow changes in hierarchy. \r\n \ + \ Connection aggregation reflects Node/Topology aggregation.\ + \ \r\n The FC represents a Cross-Connection in an NE. The Cross-Connection\ + \ in an NE is not necessarily the lowest level of FC partitioning." parameters: - name: "uuid" in: "path" @@ -213,7 +344,10 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -236,7 +370,8 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.Route" + summary: "returns tapi.connectivity.Route" + description: "none" parameters: - name: "uuid" in: "path" @@ -259,7 +394,8 @@ paths: : get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionEndPointRef" + summary: "returns tapi.connectivity.ConnectionEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -302,7 +438,10 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -330,7 +469,8 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.topology.LinkRef" + summary: "returns tapi.topology.LinkRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -358,7 +498,8 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.SwitchControl" + summary: "returns tapi.connectivity.SwitchControl" + description: "none" parameters: - name: "uuid" in: "path" @@ -381,7 +522,10 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -405,34 +549,12 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/resilience-type/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.ResilienceType" - parameters: - - name: "uuid" - in: "path" - description: "Id of connection" - required: true - type: "string" - - name: "switch-control-uuid" - in: "path" - description: "Id of switch-control" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.ResilienceType" - schema: - $ref: "#/definitions/tapi.topology.ResilienceType" - 400: - description: "Internal error" ? /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/sub-switch-control={connection-uuid},{sub-switch-control-switch-control-uuid}/ : get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.SwitchControlRef" + summary: "returns tapi.connectivity.SwitchControlRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -465,7 +587,8 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.Switch" + summary: "returns tapi.connectivity.Switch" + description: "none" parameters: - name: "uuid" in: "path" @@ -493,7 +616,10 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -526,7 +652,8 @@ paths: : get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionEndPointRef" + summary: "returns tapi.connectivity.ConnectionEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -574,7 +701,8 @@ paths: : get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.RouteRef" + summary: "returns tapi.connectivity.RouteRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -612,7 +740,8 @@ paths: post: tags: - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityService" + summary: "creates tapi.connectivity.ConnectivityService" + description: "none" parameters: - in: "body" name: "tapi.connectivity.ConnectivityService.body-param" @@ -631,7 +760,8 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityService" + summary: "returns tapi.connectivity.ConnectivityService" + description: "none" parameters: - name: "uuid" in: "path" @@ -645,33 +775,11 @@ paths: $ref: "#/definitions/tapi.connectivity.ConnectivityService" 400: description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityService" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.connectivity.ConnectivityService.body-param" - description: "tapi.connectivity.ConnectivityService to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityService" + summary: "creates or updates tapi.connectivity.ConnectivityService" + description: "none" parameters: - name: "uuid" in: "path" @@ -694,7 +802,8 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityService" + summary: "removes tapi.connectivity.ConnectivityService" + description: "none" parameters: - name: "uuid" in: "path" @@ -706,34 +815,12 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/avoid-topology={topology-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of avoid-topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" /data/context/connectivity-context/connectivity-service={uuid}/connection={connection-uuid}/: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionRef" + summary: "returns tapi.connectivity.ConnectionRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -752,11 +839,12 @@ paths: $ref: "#/definitions/tapi.connectivity.ConnectionRef" 400: description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/coroute-inclusion/: + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityServiceRef" + summary: "returns tapi.connectivity.ConnectivityConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -765,15 +853,16 @@ paths: type: "string" responses: 200: - description: "tapi.connectivity.ConnectivityServiceRef" + description: "tapi.connectivity.ConnectivityConstraint" schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" 400: description: "Internal error" post: tags: - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceRef" + summary: "creates tapi.connectivity.ConnectivityConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -781,11 +870,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.connectivity.ConnectivityServiceRef.body-param" - description: "tapi.connectivity.ConnectivityServiceRef to be added to list" + name: "tapi.connectivity.ConnectivityConstraint.body-param" + description: "tapi.connectivity.ConnectivityConstraint to be added to list" required: false schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" responses: 201: description: "Object created" @@ -796,7 +885,8 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityServiceRef" + summary: "creates or updates tapi.connectivity.ConnectivityConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -804,11 +894,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.connectivity.ConnectivityServiceRef.body-param" - description: "tapi.connectivity.ConnectivityServiceRef to be added or updated" + name: "tapi.connectivity.ConnectivityConstraint.body-param" + description: "tapi.connectivity.ConnectivityConstraint to be added or updated" required: false schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" responses: 201: description: "Object created" @@ -819,7 +909,8 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityServiceRef" + summary: "removes tapi.connectivity.ConnectivityConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -831,74 +922,42 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/cost-characteristic/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/cost-characteristic={cost-name}/: + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/coroute-inclusion/: get: tags: - "tapi-connectivity" - description: "returns tapi.topology.CostCharacteristic" + summary: "returns tapi.connectivity.ConnectivityServiceRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" responses: 200: - description: "tapi.topology.CostCharacteristic" + description: "tapi.connectivity.ConnectivityServiceRef" schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" 400: description: "Internal error" post: tags: - "tapi-connectivity" - description: "creates tapi.topology.CostCharacteristic" + summary: "creates tapi.connectivity.ConnectivityServiceRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" + name: "tapi.connectivity.ConnectivityServiceRef.body-param" + description: "tapi.connectivity.ConnectivityServiceRef to be added to list" required: false schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" responses: 201: description: "Object created" @@ -909,24 +968,20 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.topology.CostCharacteristic" + summary: "creates or updates tapi.connectivity.ConnectivityServiceRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added or updated" + name: "tapi.connectivity.ConnectivityServiceRef.body-param" + description: "tapi.connectivity.ConnectivityServiceRef to be added or updated" required: false schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" responses: 201: description: "Object created" @@ -937,28 +992,25 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.topology.CostCharacteristic" + summary: "removes tapi.connectivity.ConnectivityServiceRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/diversity-exclusion/: + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/diversity-exclusion/: post: tags: - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceRef" + summary: "creates tapi.connectivity.ConnectivityServiceRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -978,11 +1030,12 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/diversity-exclusion={connectivity-service-uuid}/: - get: + ? /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/diversity-exclusion={connectivity-service-uuid}/ + : get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityServiceRef" + summary: "returns tapi.connectivity.ConnectivityServiceRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1001,10 +1054,11 @@ paths: $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" 400: description: "Internal error" - post: + put: tags: - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceRef" + summary: "creates or updates tapi.connectivity.ConnectivityServiceRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1018,7 +1072,7 @@ paths: type: "string" - in: "body" name: "tapi.connectivity.ConnectivityServiceRef.body-param" - description: "tapi.connectivity.ConnectivityServiceRef to be added to list" + description: "tapi.connectivity.ConnectivityServiceRef to be added or updated" required: false schema: $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" @@ -1027,12 +1081,13 @@ paths: description: "Object created" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + 204: + description: "Object modified" + delete: tags: - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityServiceRef" + summary: "removes tapi.connectivity.ConnectivityServiceRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1044,44 +1099,35 @@ paths: description: "Id of diversity-exclusion" required: true type: "string" - - in: "body" - name: "tapi.connectivity.ConnectivityServiceRef.body-param" - description: "tapi.connectivity.ConnectivityServiceRef to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" responses: - 201: - description: "Object created" 400: description: "Internal error" 204: - description: "Object modified" - delete: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/requested-capacity/: + get: tags: - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityServiceRef" + summary: "returns tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "connectivity-service-uuid" - in: "path" - description: "Id of diversity-exclusion" - required: true - type: "string" responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point/: post: tags: - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceEndPoint" + summary: "creates tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" @@ -1089,12 +1135,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.connectivity.ConnectivityServiceEndPoint.body-param" - description: "tapi.connectivity.ConnectivityServiceEndPoint to be added to\ - \ list" + name: "tapi.common.Capacity.body-param" + description: "tapi.common.Capacity to be added to list" required: false schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" + $ref: "#/definitions/tapi.common.Capacity" responses: 201: description: "Object created" @@ -1102,51 +1147,84 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/: - get: + put: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityServiceEndPoint" + summary: "creates or updates tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" + - in: "body" + name: "tapi.common.Capacity.body-param" + description: "tapi.common.Capacity to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.Capacity" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.common.Capacity" + description: "none" + parameters: + - name: "uuid" in: "path" - description: "Id of end-point" + description: "Id of connectivity-service" required: true type: "string" responses: - 200: - description: "tapi.connectivity.ConnectivityServiceEndPoint" - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" 400: description: "Internal error" - post: + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/requested-capacity/total-size/: + get: tags: - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceEndPoint" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" required: true type: "string" - in: "body" - name: "tapi.connectivity.ConnectivityServiceEndPoint.body-param" - description: "tapi.connectivity.ConnectivityServiceEndPoint to be added to\ - \ list" + name: "tapi.common.CapacityValue.body-param" + description: "tapi.common.CapacityValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" + $ref: "#/definitions/tapi.common.CapacityValue" responses: 201: description: "Object created" @@ -1157,25 +1235,21 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityServiceEndPoint" + summary: "creates or updates tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - in: "body" - name: "tapi.connectivity.ConnectivityServiceEndPoint.body-param" - description: "tapi.connectivity.ConnectivityServiceEndPoint to be added or\ - \ updated" + name: "tapi.common.CapacityValue.body-param" + description: "tapi.common.CapacityValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" + $ref: "#/definitions/tapi.common.CapacityValue" responses: 201: description: "Object created" @@ -1186,67 +1260,56 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityServiceEndPoint" + summary: "removes tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/: + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/schedule/: get: tags: - "tapi-connectivity" - description: "returns tapi.common.Capacity" + summary: "returns tapi.common.TimeRange" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" responses: 200: - description: "tapi.common.Capacity" + description: "tapi.common.TimeRange" schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.common.TimeRange" 400: description: "Internal error" post: tags: - "tapi-connectivity" - description: "creates tapi.common.Capacity" + summary: "creates tapi.common.TimeRange" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - in: "body" - name: "tapi.common.Capacity.body-param" - description: "tapi.common.Capacity to be added to list" + name: "tapi.common.TimeRange.body-param" + description: "tapi.common.TimeRange to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.common.TimeRange" responses: 201: description: "Object created" @@ -1257,24 +1320,20 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.Capacity" + summary: "creates or updates tapi.common.TimeRange" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - in: "body" - name: "tapi.common.Capacity.body-param" - description: "tapi.common.Capacity to be added or updated" + name: "tapi.common.TimeRange.body-param" + description: "tapi.common.TimeRange to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.common.TimeRange" responses: 201: description: "Object created" @@ -1285,50 +1344,51 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.Capacity" + summary: "removes tapi.common.TimeRange" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/: - get: + /data/context/connectivity-context/connectivity-service={uuid}/end-point/: + post: tags: - "tapi-connectivity" - description: "returns tapi.common.BandwidthProfile" + summary: "creates tapi.connectivity.ConnectivityServiceEndPoint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" + - in: "body" + name: "tapi.connectivity.ConnectivityServiceEndPoint.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPoint to be added to\ + \ list" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/: + get: tags: - "tapi-connectivity" - description: "creates tapi.common.BandwidthProfile" + summary: "returns tapi.connectivity.ConnectivityServiceEndPoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -1340,23 +1400,18 @@ paths: description: "Id of end-point" required: true type: "string" - - in: "body" - name: "tapi.common.BandwidthProfile.body-param" - description: "tapi.common.BandwidthProfile to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" responses: - 201: - description: "Object created" + 200: + description: "tapi.connectivity.ConnectivityServiceEndPoint" + schema: + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.BandwidthProfile" + summary: "creates or updates tapi.connectivity.ConnectivityServiceEndPoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -1369,11 +1424,12 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.BandwidthProfile.body-param" - description: "tapi.common.BandwidthProfile to be added or updated" + name: "tapi.connectivity.ConnectivityServiceEndPoint.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPoint to be added or\ + \ updated" required: false schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" responses: 201: description: "Object created" @@ -1384,7 +1440,8 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.BandwidthProfile" + summary: "removes tapi.connectivity.ConnectivityServiceEndPoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -1401,11 +1458,12 @@ paths: description: "Internal error" 204: description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-burst-size/ - : get: + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/: + get: tags: - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" @@ -1419,15 +1477,16 @@ paths: type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" post: tags: - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + summary: "creates tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" @@ -1440,11 +1499,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.common.Capacity.body-param" + description: "tapi.common.Capacity to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" responses: 201: description: "Object created" @@ -1455,7 +1514,8 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" @@ -1468,11 +1528,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.common.Capacity.body-param" + description: "tapi.common.Capacity to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" responses: 201: description: "Object created" @@ -1483,7 +1543,8 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" @@ -1500,11 +1561,13 @@ paths: description: "Internal error" 204: description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-information-rate/ - : get: + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/total-size/: + get: tags: - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -1526,7 +1589,9 @@ paths: post: tags: - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + summary: "creates tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -1554,7 +1619,9 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -1582,7 +1649,9 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -1599,11 +1668,12 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-burst-size/: - get: + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/connection-end-point={topology-uuid},{node-uuid},{node-edge-point-uuid},{connection-end-point-uuid}/ + : get: tags: - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.connectivity.ConnectionEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1615,17 +1685,41 @@ paths: description: "Id of end-point" required: true type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.connectivity.ConnectionEndPointRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.connectivity.ConnectionEndPointRef" 400: description: "Internal error" + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/name/: post: tags: - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -1638,11 +1732,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -1650,10 +1744,44 @@ paths: description: "Internal error" 409: description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/name={value-name}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -1665,12 +1793,17 @@ paths: description: "Id of end-point" required: true type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -1681,7 +1814,10 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -1693,16 +1829,22 @@ paths: description: "Id of end-point" required: true type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-information-rate/ - : get: + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/peer-fwd-connectivity-service-end-point/: + get: tags: - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1716,15 +1858,16 @@ paths: type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.connectivity.ConnectivityServiceEndPointRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" 400: description: "Internal error" post: tags: - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + summary: "creates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1737,11 +1880,12 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" responses: 201: description: "Object created" @@ -1752,7 +1896,8 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1765,11 +1910,12 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" responses: 201: description: "Object created" @@ -1780,7 +1926,8 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1797,11 +1944,12 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/total-size/: + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/protecting-connectivity-service-end-point/: get: tags: - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1815,15 +1963,16 @@ paths: type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.connectivity.ConnectivityServiceEndPointRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" 400: description: "Internal error" post: tags: - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + summary: "creates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1836,11 +1985,12 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" responses: 201: description: "Object created" @@ -1851,7 +2001,8 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1864,11 +2015,12 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" responses: 201: description: "Object created" @@ -1879,7 +2031,8 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1896,83 +2049,12 @@ paths: description: "Internal error" 204: description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/connection-end-point={topology-uuid},{node-uuid},{node-edge-point-uuid},{connection-end-point-uuid}/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.connectivity.ConnectionEndPointRef" - schema: - $ref: "#/definitions/tapi.connectivity.ConnectionEndPointRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/name/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/name={value-name}/: + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/server-connectivity-service-end-point/: get: tags: - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1984,22 +2066,18 @@ paths: description: "Id of end-point" required: true type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.connectivity.ConnectivityServiceEndPointRef" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" 400: description: "Internal error" post: tags: - "tapi-connectivity" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -2011,17 +2089,13 @@ paths: description: "Id of end-point" required: true type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ to list" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" responses: 201: description: "Object created" @@ -2032,7 +2106,8 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.NameAndValue" + summary: "creates or updates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -2044,17 +2119,13 @@ paths: description: "Id of end-point" required: true type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ or updated" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" responses: 201: description: "Object created" @@ -2065,7 +2136,8 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -2077,11 +2149,6 @@ paths: description: "Id of end-point" required: true type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" responses: 400: description: "Internal error" @@ -2091,7 +2158,8 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.common.ServiceInterfacePointRef" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -2113,7 +2181,8 @@ paths: post: tags: - "tapi-connectivity" - description: "creates tapi.common.ServiceInterfacePointRef" + summary: "creates tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -2141,7 +2210,8 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.ServiceInterfacePointRef" + summary: "creates or updates tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -2169,7 +2239,8 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.ServiceInterfacePointRef" + summary: "removes tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -2186,255 +2257,232 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/exclude-link={topology-uuid},{link-uuid}/: - get: + /data/context/connectivity-context/connectivity-service={uuid}/name/: + post: tags: - "tapi-connectivity" - description: "returns tapi.topology.LinkRef" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of exclude-link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of exclude-link" - required: true - type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/exclude-node={topology-uuid},{node-uuid}/: + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/name={value-name}/: get: tags: - "tapi-connectivity" - description: "returns tapi.topology.NodeRef" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of exclude-node" - required: true - type: "string" - - name: "node-uuid" + - name: "value-name" in: "path" - description: "Id of exclude-node" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.topology.NodeRef" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.topology.NodeRef" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/exclude-path={path-uuid}/: - get: + put: tags: - "tapi-connectivity" - description: "returns tapi.path.computation.PathRef" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "path-uuid" + - name: "value-name" in: "path" - description: "Id of exclude-path" + description: "Id of name" required: true type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/include-link={topology-uuid},{link-uuid}/: - get: + 204: + description: "Object modified" + delete: tags: - "tapi-connectivity" - description: "returns tapi.topology.LinkRef" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-link" - required: true - type: "string" - - name: "link-uuid" + - name: "value-name" in: "path" - description: "Id of include-link" + description: "Id of name" required: true type: "string" responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" 400: description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/include-node={topology-uuid},{node-uuid}/: + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/resilience-constraint/: get: tags: - "tapi-connectivity" - description: "returns tapi.topology.NodeRef" + summary: "returns tapi.connectivity.ResilienceConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-node" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of include-node" - required: true - type: "string" responses: 200: - description: "tapi.topology.NodeRef" + description: "tapi.connectivity.ResilienceConstraint" schema: - $ref: "#/definitions/tapi.topology.NodeRef" + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" 400: description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/include-path={path-uuid}/: - get: + post: tags: - "tapi-connectivity" - description: "returns tapi.path.computation.PathRef" + summary: "creates tapi.connectivity.ResilienceConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "path-uuid" - in: "path" - description: "Id of include-path" - required: true - type: "string" + - in: "body" + name: "tapi.connectivity.ResilienceConstraint.body-param" + description: "tapi.connectivity.ResilienceConstraint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/include-topology={topology-uuid}/: - get: + 409: + description: "Object already exists" + put: tags: - "tapi-connectivity" - description: "returns tapi.topology.TopologyRef" + summary: "creates or updates tapi.connectivity.ResilienceConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-topology" - required: true - type: "string" + - in: "body" + name: "tapi.connectivity.ResilienceConstraint.body-param" + description: "tapi.connectivity.ResilienceConstraint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/latency-characteristic/: - post: + 204: + description: "Object modified" + delete: tags: - "tapi-connectivity" - description: "creates tapi.topology.LatencyCharacteristic" + summary: "removes tapi.connectivity.ResilienceConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" responses: - 201: - description: "Object created" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/latency-characteristic={traffic-property-name}/: + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/: get: tags: - "tapi-connectivity" - description: "returns tapi.topology.LatencyCharacteristic" + summary: "returns tapi.path.computation.RoutingConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" responses: 200: - description: "tapi.topology.LatencyCharacteristic" + description: "tapi.path.computation.RoutingConstraint" schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" 400: description: "Internal error" post: tags: - "tapi-connectivity" - description: "creates tapi.topology.LatencyCharacteristic" + summary: "creates tapi.path.computation.RoutingConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" + name: "tapi.path.computation.RoutingConstraint.body-param" + description: "tapi.path.computation.RoutingConstraint to be added to list" required: false schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" responses: 201: description: "Object created" @@ -2445,24 +2493,20 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.topology.LatencyCharacteristic" + summary: "creates or updates tapi.path.computation.RoutingConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added or updated" + name: "tapi.path.computation.RoutingConstraint.body-param" + description: "tapi.path.computation.RoutingConstraint to be added or updated" required: false schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" responses: 201: description: "Object created" @@ -2473,28 +2517,26 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.topology.LatencyCharacteristic" + summary: "removes tapi.path.computation.RoutingConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/name/: + /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/cost-characteristic/: post: tags: - "tapi-connectivity" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" @@ -2502,11 +2544,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.topology.CostCharacteristic.body-param" + description: "tapi.topology.CostCharacteristic to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.topology.CostCharacteristic" responses: 201: description: "Object created" @@ -2514,78 +2556,54 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/name={value-name}/: + /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/cost-characteristic={cost-name}/: get: tags: - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "value-name" + - name: "cost-name" in: "path" - description: "Id of name" + description: "Id of cost-characteristic" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.topology.CostCharacteristic" schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" + $ref: "#/definitions/tapi.topology.CostCharacteristic" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.NameAndValue" + summary: "creates or updates tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "value-name" + - name: "cost-name" in: "path" - description: "Id of name" + description: "Id of cost-characteristic" required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" + name: "tapi.topology.CostCharacteristic.body-param" + description: "tapi.topology.CostCharacteristic to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.topology.CostCharacteristic" responses: 201: description: "Object created" @@ -2596,16 +2614,18 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "value-name" + - name: "cost-name" in: "path" - description: "Id of name" + description: "Id of cost-characteristic" required: true type: "string" responses: @@ -2613,63 +2633,80 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/: - get: + /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/latency-characteristic/: + post: tags: - "tapi-connectivity" - description: "returns tapi.common.Capacity" + summary: "creates tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - in: "body" + name: "tapi.topology.LatencyCharacteristic.body-param" + description: "tapi.topology.LatencyCharacteristic to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + ? /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/ + : get: tags: - "tapi-connectivity" - description: "creates tapi.common.Capacity" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - in: "body" - name: "tapi.common.Capacity.body-param" - description: "tapi.common.Capacity to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.Capacity" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" responses: - 201: - description: "Object created" + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.Capacity" + summary: "creates or updates tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" - in: "body" - name: "tapi.common.Capacity.body-param" - description: "tapi.common.Capacity to be added or updated" + name: "tapi.topology.LatencyCharacteristic.body-param" + description: "tapi.topology.LatencyCharacteristic to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" responses: 201: description: "Object created" @@ -2680,75 +2717,96 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.Capacity" + summary: "removes tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/: - get: + /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/risk-diversity-characteristic/: + post: tags: - "tapi-connectivity" - description: "returns tapi.common.BandwidthProfile" + summary: "creates tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - in: "body" + name: "tapi.topology.RiskCharacteristic.body-param" + description: "tapi.topology.RiskCharacteristic to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + ? /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/ + : get: tags: - "tapi-connectivity" - description: "creates tapi.common.BandwidthProfile" + summary: "returns tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - in: "body" - name: "tapi.common.BandwidthProfile.body-param" - description: "tapi.common.BandwidthProfile to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-diversity-characteristic" + required: true + type: "string" responses: - 201: - description: "Object created" + 200: + description: "tapi.topology.RiskCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.BandwidthProfile" + summary: "creates or updates tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-diversity-characteristic" + required: true + type: "string" - in: "body" - name: "tapi.common.BandwidthProfile.body-param" - description: "tapi.common.BandwidthProfile to be added or updated" + name: "tapi.topology.RiskCharacteristic.body-param" + description: "tapi.topology.RiskCharacteristic to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.topology.RiskCharacteristic" responses: 201: description: "Object created" @@ -2759,40 +2817,30 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.BandwidthProfile" + summary: "removes tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" + - name: "risk-characteristic-name" in: "path" - description: "Id of connectivity-service" + description: "Id of risk-diversity-characteristic" required: true type: "string" responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/topology-constraint/: post: tags: - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + summary: "creates tapi.path.computation.TopologyConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -2800,11 +2848,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.path.computation.TopologyConstraint.body-param" + description: "tapi.path.computation.TopologyConstraint to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" responses: 201: description: "Object created" @@ -2812,78 +2860,105 @@ paths: description: "Internal error" 409: description: "Object already exists" - put: + /data/context/connectivity-context/connectivity-service={uuid}/topology-constraint={local-id}/: + get: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + summary: "returns tapi.path.computation.TopologyConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" responses: - 201: - description: "Object created" + 200: + description: "tapi.path.computation.TopologyConstraint" + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + put: tags: - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + summary: "creates or updates tapi.path.computation.TopologyConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.TopologyConstraint.body-param" + description: "tapi.path.computation.TopologyConstraint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" responses: + 201: + description: "Object created" 400: description: "Internal error" 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/committed-information-rate/: - get: + description: "Object modified" + delete: tags: - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" + summary: "removes tapi.path.computation.TopologyConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/topology-constraint={local-id}/name/: post: tags: - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -2891,78 +2966,116 @@ paths: description: "Internal error" 409: description: "Object already exists" - put: + /data/context/connectivity-context/connectivity-service={uuid}/topology-constraint={local-id}/name={value-name}/: + get: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" responses: - 201: - description: "Object created" + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + put: tags: - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" responses: + 201: + description: "Object created" 400: description: "Internal error" 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/peak-burst-size/: - get: + description: "Object modified" + delete: tags: - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" + 204: + description: "Object deleted" + /data/context/name/: post: tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + - "tapi-common" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -2970,22 +3083,46 @@ paths: description: "Internal error" 409: description: "Object already exists" + /data/context/name={value-name}/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" put: tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + - "tapi-common" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - - name: "uuid" + - name: "value-name" in: "path" - description: "Id of connectivity-service" + description: "Id of name" required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -2995,12 +3132,15 @@ paths: description: "Object modified" delete: tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + - "tapi-common" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - - name: "uuid" + - name: "value-name" in: "path" - description: "Id of connectivity-service" + description: "Id of name" required: true type: "string" responses: @@ -3008,40 +3148,33 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/peak-information-rate/: + /data/context/notification-context/: get: tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" + - "tapi-notification" + summary: "returns tapi.notification.context.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: [] responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.notification.context.NotificationContext" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.notification.context.NotificationContext" 400: description: "Internal error" post: tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + - "tapi-notification" + summary: "creates tapi.notification.context.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.notification.context.NotificationContext.body-param" + description: "tapi.notification.context.NotificationContext to be added to\ + \ list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.notification.context.NotificationContext" responses: 201: description: "Object created" @@ -3051,20 +3184,17 @@ paths: description: "Object already exists" put: tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + - "tapi-notification" + summary: "creates or updates tapi.notification.context.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.notification.context.NotificationContext.body-param" + description: "tapi.notification.context.NotificationContext to be added or\ + \ updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.notification.context.NotificationContext" responses: 201: description: "Object created" @@ -3074,76 +3204,73 @@ paths: description: "Object modified" delete: tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" + - "tapi-notification" + summary: "removes tapi.notification.context.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: [] responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/total-size/: - get: + /data/context/notification-context/notif-subscription/: + post: tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" + - "tapi-notification" + summary: "creates tapi.notification.NotificationSubscriptionService" + description: "none" parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" + - in: "body" + name: "tapi.notification.NotificationSubscriptionService.body-param" + description: "tapi.notification.NotificationSubscriptionService to be added\ + \ to list" + required: false + schema: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + /data/context/notification-context/notif-subscription={uuid}/: + get: tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + - "tapi-notification" + summary: "returns tapi.notification.NotificationSubscriptionService" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" required: true type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.notification.NotificationSubscriptionService" + schema: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + - "tapi-notification" + summary: "creates or updates tapi.notification.NotificationSubscriptionService" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.notification.NotificationSubscriptionService.body-param" + description: "tapi.notification.NotificationSubscriptionService to be added\ + \ or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" responses: 201: description: "Object created" @@ -3153,12 +3280,13 @@ paths: description: "Object modified" delete: tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + - "tapi-notification" + summary: "removes tapi.notification.NotificationSubscriptionService" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" required: true type: "string" responses: @@ -3166,63 +3294,83 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/resilience-type/: - get: + /data/context/notification-context/notif-subscription={uuid}/name/: + post: tags: - - "tapi-connectivity" - description: "returns tapi.topology.ResilienceType" + - "tapi-notification" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" required: true type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" responses: - 200: - description: "tapi.topology.ResilienceType" - schema: - $ref: "#/definitions/tapi.topology.ResilienceType" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + /data/context/notification-context/notif-subscription={uuid}/name={value-name}/: + get: tags: - - "tapi-connectivity" - description: "creates tapi.topology.ResilienceType" + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" required: true type: "string" - - in: "body" - name: "tapi.topology.ResilienceType.body-param" - description: "tapi.topology.ResilienceType to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.ResilienceType" responses: - 201: - description: "Object created" + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - - "tapi-connectivity" - description: "creates or updates tapi.topology.ResilienceType" + - "tapi-notification" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" required: true type: "string" - in: "body" - name: "tapi.topology.ResilienceType.body-param" - description: "tapi.topology.ResilienceType to be added or updated" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.topology.ResilienceType" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -3232,12 +3380,20 @@ paths: description: "Object modified" delete: tags: - - "tapi-connectivity" - description: "removes tapi.topology.ResilienceType" + - "tapi-notification" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" required: true type: "string" responses: @@ -3245,261 +3401,229 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/risk-diversity-characteristic/: - post: + /data/context/notification-context/notif-subscription={uuid}/notification-channel/: + get: tags: - - "tapi-connectivity" - description: "creates tapi.topology.RiskCharacteristic" + - "tapi-notification" + summary: "returns tapi.notification.NotificationChannel" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" required: true type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" responses: - 201: - description: "Object created" + 200: + description: "tapi.notification.NotificationChannel" + schema: + $ref: "#/definitions/tapi.notification.NotificationChannel" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/risk-diversity-characteristic={risk-characteristic-name}/: + /data/context/notification-context/notif-subscription={uuid}/notification-channel/name={value-name}/: get: tags: - - "tapi-connectivity" - description: "returns tapi.topology.RiskCharacteristic" + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" required: true type: "string" - - name: "risk-characteristic-name" + - name: "value-name" in: "path" - description: "Id of risk-diversity-characteristic" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.topology.RiskCharacteristic" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/: + get: tags: - - "tapi-connectivity" - description: "creates tapi.topology.RiskCharacteristic" + - "tapi-notification" + summary: "returns tapi.notification.Notification" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" required: true type: "string" - - name: "risk-characteristic-name" + - name: "notification-uuid" in: "path" - description: "Id of risk-diversity-characteristic" + description: "Id of notification" required: true type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" responses: - 201: - description: "Object created" + 200: + description: "tapi.notification.Notification" + schema: + $ref: "#/definitions/tapi.notification.Notification" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/additional-info={value-name}/: + get: tags: - - "tapi-connectivity" - description: "creates or updates tapi.topology.RiskCharacteristic" + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" required: true type: "string" - - name: "risk-characteristic-name" + - name: "notification-uuid" in: "path" - description: "Id of risk-diversity-characteristic" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of additional-info" required: true type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" responses: - 201: - description: "Object created" + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/changed-attributes={value-name}/: + get: tags: - - "tapi-connectivity" - description: "removes tapi.topology.RiskCharacteristic" + - "tapi-notification" + summary: "returns tapi.notification.NameAndValueChange" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" required: true type: "string" - - name: "risk-characteristic-name" + - name: "notification-uuid" in: "path" - description: "Id of risk-diversity-characteristic" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of changed-attributes" required: true type: "string" responses: + 200: + description: "tapi.notification.NameAndValueChange" + schema: + $ref: "#/definitions/tapi.notification.NameAndValueChange" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/schedule/: + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/name={value-name}/: get: tags: - - "tapi-connectivity" - description: "returns tapi.common.TimeRange" + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.common.TimeRange" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.common.TimeRange" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/target-object-name={value-name}/: + get: tags: - - "tapi-connectivity" - description: "creates tapi.common.TimeRange" + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" required: true type: "string" - - in: "body" - name: "tapi.common.TimeRange.body-param" - description: "tapi.common.TimeRange to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.TimeRange" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.TimeRange" - parameters: - - name: "uuid" + - name: "notification-uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of target-object-name" required: true type: "string" - - in: "body" - name: "tapi.common.TimeRange.body-param" - description: "tapi.common.TimeRange to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.TimeRange" responses: - 201: - description: "Object created" + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/: + get: tags: - - "tapi-connectivity" - description: "removes tapi.common.TimeRange" + - "tapi-notification" + summary: "returns tapi.notification.SubscriptionFilter" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/name/: - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/name={value-name}/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of notif-subscription" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.notification.SubscriptionFilter" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" 400: description: "Internal error" post: tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" + - "tapi-notification" + summary: "creates tapi.notification.SubscriptionFilter" + description: "none" parameters: - - name: "value-name" + - name: "uuid" in: "path" - description: "Id of name" + description: "Id of notif-subscription" required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.notification.SubscriptionFilter.body-param" + description: "tapi.notification.SubscriptionFilter to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" responses: 201: description: "Object created" @@ -3509,20 +3633,21 @@ paths: description: "Object already exists" put: tags: - - "tapi-common" - description: "creates or updates tapi.common.NameAndValue" + - "tapi-notification" + summary: "creates or updates tapi.notification.SubscriptionFilter" + description: "none" parameters: - - name: "value-name" + - name: "uuid" in: "path" - description: "Id of name" + description: "Id of notif-subscription" required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" + name: "tapi.notification.SubscriptionFilter.body-param" + description: "tapi.notification.SubscriptionFilter to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" responses: 201: description: "Object created" @@ -3532,12 +3657,13 @@ paths: description: "Object modified" delete: tags: - - "tapi-common" - description: "removes tapi.common.NameAndValue" + - "tapi-notification" + summary: "removes tapi.notification.SubscriptionFilter" + description: "none" parameters: - - name: "value-name" + - name: "uuid" in: "path" - description: "Id of name" + description: "Id of notif-subscription" required: true type: "string" responses: @@ -3545,78 +3671,26 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/notification-context/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NotificationContext" - parameters: [] - responses: - 200: - description: "tapi.notification.NotificationContext" - schema: - $ref: "#/definitions/tapi.notification.NotificationContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationContext" - parameters: - - in: "body" - name: "tapi.notification.NotificationContext.body-param" - description: "tapi.notification.NotificationContext to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.notification.NotificationContext" - parameters: - - in: "body" - name: "tapi.notification.NotificationContext.body-param" - description: "tapi.notification.NotificationContext to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.notification.NotificationContext" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription/: + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name/: post: tags: - "tapi-notification" - description: "creates tapi.notification.NotificationSubscriptionService" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" - in: "body" - name: "tapi.notification.NotificationSubscriptionService.body-param" - description: "tapi.notification.NotificationSubscriptionService to be added\ - \ to list" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -3624,65 +3698,56 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/: + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name={value-name}/: get: tags: - "tapi-notification" - description: "returns tapi.notification.NotificationSubscriptionService" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of notif-subscription" required: true type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" responses: 200: - description: "tapi.notification.NotificationSubscriptionService" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: + put: tags: - "tapi-notification" - description: "creates tapi.notification.NotificationSubscriptionService" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of notif-subscription" required: true type: "string" - - in: "body" - name: "tapi.notification.NotificationSubscriptionService.body-param" - description: "tapi.notification.NotificationSubscriptionService to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.notification.NotificationSubscriptionService" - parameters: - - name: "uuid" + - name: "value-name" in: "path" - description: "Id of notif-subscription" + description: "Id of name" required: true type: "string" - in: "body" - name: "tapi.notification.NotificationSubscriptionService.body-param" - description: "tapi.notification.NotificationSubscriptionService to be added\ - \ or updated" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -3693,56 +3758,60 @@ paths: delete: tags: - "tapi-notification" - description: "removes tapi.notification.NotificationSubscriptionService" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of notif-subscription" required: true type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/name/: - post: + /data/context/notification-context/notification={uuid}/: + get: tags: - "tapi-notification" - description: "creates tapi.common.NameAndValue" + summary: "returns tapi.notification.notificationcontext.Notification" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of notification" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.notification.notificationcontext.Notification" + schema: + $ref: "#/definitions/tapi.notification.notificationcontext.Notification" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/name={value-name}/: + /data/context/notification-context/notification={uuid}/additional-info={value-name}/: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of notification" required: true type: "string" - name: "value-name" in: "path" - description: "Id of name" + description: "Id of additional-info" required: true type: "string" responses: @@ -3752,70 +3821,61 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: + /data/context/notification-context/notification={uuid}/alarm-info/: + get: tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" + - "tapi-oam" + summary: "returns tapi.oam.AlarmInfo" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of notification" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.oam.AlarmInfo" + schema: + $ref: "#/definitions/tapi.oam.AlarmInfo" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + /data/context/notification-context/notification={uuid}/changed-attributes={value-name}/: + get: tags: - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" + summary: "returns tapi.notification.NameAndValueChange" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of notification" required: true type: "string" - name: "value-name" in: "path" - description: "Id of name" + description: "Id of changed-attributes" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.notification.NameAndValueChange" + schema: + $ref: "#/definitions/tapi.notification.NameAndValueChange" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + /data/context/notification-context/notification={uuid}/name={value-name}/: + get: tags: - "tapi-notification" - description: "removes tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of notification" required: true type: "string" - name: "value-name" @@ -3824,157 +3884,177 @@ paths: required: true type: "string" responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/notification-channel/: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/target-object-name={value-name}/: get: tags: - "tapi-notification" - description: "returns tapi.notification.NotificationChannel" + summary: "returns tapi.common.NameAndValue" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of target-object-name" required: true type: "string" responses: 200: - description: "tapi.notification.NotificationChannel" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: + /data/context/notification-context/notification={uuid}/tca-info/: + get: tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationChannel" + - "tapi-oam" + summary: "returns tapi.oam.TcaInfo" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of notification" required: true type: "string" - - in: "body" - name: "tapi.notification.NotificationChannel.body-param" - description: "tapi.notification.NotificationChannel to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" responses: - 201: - description: "Object created" + 200: + description: "tapi.oam.TcaInfo" + schema: + $ref: "#/definitions/tapi.oam.TcaInfo" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + /data/context/notification-context/notification={uuid}/tca-info/oam-job/: + get: tags: - - "tapi-notification" - description: "creates or updates tapi.notification.NotificationChannel" + - "tapi-oam" + summary: "returns tapi.oam.OamJobRef" + description: "MEF 35.1\r\n Identification of the PM Session for\ + \ which the TCA Function was configured." parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of notification" required: true type: "string" - - in: "body" - name: "tapi.notification.NotificationChannel.body-param" - description: "tapi.notification.NotificationChannel to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" responses: - 201: - description: "Object created" + 200: + description: "tapi.oam.OamJobRef" + schema: + $ref: "#/definitions/tapi.oam.OamJobRef" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + /data/context/notification-context/notification={uuid}/tca-info/threshold-parameter/: + get: tags: - - "tapi-notification" - description: "removes tapi.notification.NotificationChannel" + - "tapi-oam" + summary: "returns tapi.oam.ThresholdParameter" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of notification" required: true type: "string" responses: + 200: + description: "tapi.oam.ThresholdParameter" + schema: + $ref: "#/definitions/tapi.oam.ThresholdParameter" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/notification-channel/name/: - post: + /data/context/notification-context/notification={uuid}/tca-info/threshold-parameter/pm-parameter-above-thrs/: + get: tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" + - "tapi-oam" + summary: "returns tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of notification" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.oam.PmParameterValue" + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/notification-channel/name={value-name}/: + /data/context/notification-context/notification={uuid}/tca-info/threshold-parameter/pm-parameter-below-thrs/: get: tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" + - "tapi-oam" + summary: "returns tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of notification" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.oam.PmParameterValue" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.oam.PmParameterValue" 400: description: "Internal error" - post: + /data/context/notification-context/notification={uuid}/tca-info/threshold-parameter/pm-parameter-clear-thrs/: + get: tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" + - "tapi-oam" + summary: "returns tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of notification" required: true type: "string" + responses: + 200: + description: "tapi.oam.PmParameterValue" + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + 400: + description: "Internal error" + /data/context/oam-context/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.OamContext" + description: "Augments the base TAPI Context with OamService information" + parameters: [] + responses: + 200: + description: "tapi.oam.OamContext" + schema: + $ref: "#/definitions/tapi.oam.OamContext" + 400: + description: "Internal error" + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.OamContext" + description: "Augments the base TAPI Context with OamService information" + parameters: - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.oam.OamContext.body-param" + description: "tapi.oam.OamContext to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.oam.OamContext" responses: 201: description: "Object created" @@ -3984,25 +4064,16 @@ paths: description: "Object already exists" put: tags: - - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" + - "tapi-oam" + summary: "creates or updates tapi.oam.OamContext" + description: "Augments the base TAPI Context with OamService information" parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" + name: "tapi.oam.OamContext.body-param" + description: "tapi.oam.OamContext to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.oam.OamContext" responses: 201: description: "Object created" @@ -4012,66 +4083,83 @@ paths: description: "Object modified" delete: tags: - - "tapi-notification" - description: "removes tapi.common.NameAndValue" + - "tapi-oam" + summary: "removes tapi.oam.OamContext" + description: "Augments the base TAPI Context with OamService information" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/meg={uuid}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.Meg" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of meg" required: true type: "string" responses: + 200: + description: "tapi.oam.Meg" + schema: + $ref: "#/definitions/tapi.oam.Meg" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/: + /data/context/oam-context/meg={uuid}/mep={local-id}/: get: tags: - - "tapi-notification" - description: "returns tapi.notification.Notification" + - "tapi-oam" + summary: "returns tapi.oam.Mep" + description: "1. ME may have 0 MEPs (case of transit domains where at least\ + \ 1 MIP is present)\r\n 2. ME may have 1 MEP (case of edge\ + \ domaind, where the peer MEP is ouside the managed domain)\r\n \ + \ 3. ME may have 2 MEPs" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of meg" required: true type: "string" - - name: "notification-uuid" + - name: "local-id" in: "path" - description: "Id of notification" + description: "Id of mep" required: true type: "string" responses: 200: - description: "tapi.notification.Notification" + description: "tapi.oam.Mep" schema: - $ref: "#/definitions/tapi.notification.Notification" + $ref: "#/definitions/tapi.oam.Mep" 400: description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/additional-info={value-name}/: + /data/context/oam-context/meg={uuid}/mep={local-id}/name={value-name}/: get: tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of meg" required: true type: "string" - - name: "notification-uuid" + - name: "local-id" in: "path" - description: "Id of notification" + description: "Id of mep" required: true type: "string" - name: "value-name" in: "path" - description: "Id of additional-info" + description: "Id of name" required: true type: "string" responses: @@ -4081,71 +4169,73 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/alarm-info/: + /data/context/oam-context/meg={uuid}/mip={local-id}/: get: tags: - - "tapi-notification" - description: "returns tapi.notification.AlarmInfo" + - "tapi-oam" + summary: "returns tapi.oam.Mip" + description: "ME may 0, 1, or more MIPs" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of meg" required: true type: "string" - - name: "notification-uuid" + - name: "local-id" in: "path" - description: "Id of notification" + description: "Id of mip" required: true type: "string" responses: 200: - description: "tapi.notification.AlarmInfo" + description: "tapi.oam.Mip" schema: - $ref: "#/definitions/tapi.notification.AlarmInfo" + $ref: "#/definitions/tapi.oam.Mip" 400: description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/changed-attributes={value-name}/: + /data/context/oam-context/meg={uuid}/mip={local-id}/name={value-name}/: get: tags: - - "tapi-notification" - description: "returns tapi.notification.NameAndValueChange" + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of meg" required: true type: "string" - - name: "notification-uuid" + - name: "local-id" in: "path" - description: "Id of notification" + description: "Id of mip" required: true type: "string" - name: "value-name" in: "path" - description: "Id of changed-attributes" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.notification.NameAndValueChange" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.notification.NameAndValueChange" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/name={value-name}/: + /data/context/oam-context/meg={uuid}/name={value-name}/: get: tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" + description: "Id of meg" required: true type: "string" - name: "value-name" @@ -4160,114 +4250,62 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/target-object-name={value-name}/: - get: + /data/context/oam-context/oam-job/: + post: tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" + - "tapi-oam" + summary: "creates tapi.oam.OamJob" + description: "none" parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of target-object-name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/tca-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.TcaInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" + - in: "body" + name: "tapi.oam.OamJob.body-param" + description: "tapi.oam.OamJob to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamJob" responses: - 200: - description: "tapi.notification.TcaInfo" - schema: - $ref: "#/definitions/tapi.notification.TcaInfo" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/subscription-filter/: + 409: + description: "Object already exists" + /data/context/oam-context/oam-job={uuid}/: get: tags: - - "tapi-notification" - description: "returns tapi.notification.SubscriptionFilter" + - "tapi-oam" + summary: "returns tapi.oam.OamJob" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of oam-job" required: true type: "string" responses: 200: - description: "tapi.notification.SubscriptionFilter" + description: "tapi.oam.OamJob" schema: - $ref: "#/definitions/tapi.notification.SubscriptionFilter" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.SubscriptionFilter" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.SubscriptionFilter.body-param" - description: "tapi.notification.SubscriptionFilter to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.SubscriptionFilter" - responses: - 201: - description: "Object created" + $ref: "#/definitions/tapi.oam.OamJob" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - - "tapi-notification" - description: "creates or updates tapi.notification.SubscriptionFilter" + - "tapi-oam" + summary: "creates or updates tapi.oam.OamJob" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of oam-job" required: true type: "string" - in: "body" - name: "tapi.notification.SubscriptionFilter.body-param" - description: "tapi.notification.SubscriptionFilter to be added or updated" + name: "tapi.oam.OamJob.body-param" + description: "tapi.oam.OamJob to be added or updated" required: false schema: - $ref: "#/definitions/tapi.notification.SubscriptionFilter" + $ref: "#/definitions/tapi.oam.OamJob" responses: 201: description: "Object created" @@ -4277,12 +4315,13 @@ paths: description: "Object modified" delete: tags: - - "tapi-notification" - description: "removes tapi.notification.SubscriptionFilter" + - "tapi-oam" + summary: "removes tapi.oam.OamJob" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of oam-job" required: true type: "string" responses: @@ -4290,161 +4329,146 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name/: - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name={value-name}/: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/: get: tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" + - "tapi-oam" + summary: "returns tapi.oam.CurrentData" + description: "Granularity period of the CurrentData identifies the specific\ + \ CurrentData instance in the scope of this OamJob.\r\n For\ + \ example, typically at least\r\n one 15min and\r\n \ + \ one 24hr;\r\n optionally one additional configurable\ + \ (< 15min)" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of oam-job" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of name" + description: "Id of current-data" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.oam.CurrentData" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.oam.CurrentData" 400: description: "Internal error" - post: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/elapsed-time/: + get: tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" + - "tapi-oam" + summary: "returns tapi.common.TimeInterval" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of oam-job" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of name" + description: "Id of current-data" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.common.TimeInterval" + schema: + $ref: "#/definitions/tapi.common.TimeInterval" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/elapsed-time/period={unit}/: + get: tags: - - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" + - "tapi-oam" + summary: "returns tapi.common.TimePeriod" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of oam-job" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of name" + description: "Id of current-data" + required: true + type: "string" + - name: "unit" + in: "path" + description: "Id of period" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.common.TimePeriod" + schema: + $ref: "#/definitions/tapi.common.TimePeriod" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/: + get: tags: - - "tapi-notification" - description: "removes tapi.common.NameAndValue" + - "tapi-oam" + summary: "returns tapi.oam.HistoryData" + description: "in case of 24hr Current Data, at least 1 History Data.\r\n \ + \ In case of 15min Current Data, at least 16 History Data.\r\n\ + \ In case of <15min, the number of History Data shall be able\ + \ to cover a span of 4 hours." parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of oam-job" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of name" + description: "Id of current-data" required: true type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notification={uuid}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.Notification" - parameters: - - name: "uuid" + - name: "history-data-local-id" in: "path" - description: "Id of notification" + description: "Id of history-data" required: true type: "string" responses: 200: - description: "tapi.notification.Notification" + description: "tapi.oam.HistoryData" schema: - $ref: "#/definitions/tapi.notification.Notification" + $ref: "#/definitions/tapi.oam.HistoryData" 400: description: "Internal error" - /data/context/notification-context/notification={uuid}/additional-info={value-name}/: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/name={value-name}/: get: tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of notification" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" required: true type: "string" - name: "value-name" in: "path" - description: "Id of additional-info" + description: "Id of name" required: true type: "string" responses: @@ -4454,84 +4478,86 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/notification-context/notification={uuid}/alarm-info/: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/pm-data-pac/: get: tags: - - "tapi-notification" - description: "returns tapi.notification.AlarmInfo" + - "tapi-oam" + summary: "returns tapi.oam.PmDataPac" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notification" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" required: true type: "string" responses: 200: - description: "tapi.notification.AlarmInfo" + description: "tapi.oam.PmDataPac" schema: - $ref: "#/definitions/tapi.notification.AlarmInfo" + $ref: "#/definitions/tapi.oam.PmDataPac" 400: description: "Internal error" - /data/context/notification-context/notification={uuid}/changed-attributes={value-name}/: - get: + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/pm-data-pac/granularity-period/ + : get: tags: - - "tapi-notification" - description: "returns tapi.notification.NameAndValueChange" + - "tapi-oam" + summary: "returns tapi.common.TimePeriod" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notification" + description: "Id of oam-job" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of changed-attributes" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" required: true type: "string" responses: 200: - description: "tapi.notification.NameAndValueChange" + description: "tapi.common.TimePeriod" schema: - $ref: "#/definitions/tapi.notification.NameAndValueChange" + $ref: "#/definitions/tapi.common.TimePeriod" 400: description: "Internal error" - /data/context/notification-context/notification={uuid}/name={value-name}/: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/name={value-name}/: get: tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of notification" + description: "Id of oam-job" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/target-object-name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" + description: "Id of current-data" required: true type: "string" - name: "value-name" in: "path" - description: "Id of target-object-name" + description: "Id of name" required: true type: "string" responses: @@ -4541,189 +4567,118 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/notification-context/notification={uuid}/tca-info/: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/pm-data-pac/: get: tags: - - "tapi-notification" - description: "returns tapi.notification.TcaInfo" + - "tapi-oam" + summary: "returns tapi.oam.PmDataPac" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notification" + description: "Id of oam-job" required: true type: "string" - responses: - 200: - description: "tapi.notification.TcaInfo" - schema: - $ref: "#/definitions/tapi.notification.TcaInfo" - 400: - description: "Internal error" - /data/context/oam-context/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.OamContext" - parameters: [] - responses: - 200: - description: "tapi.oam.OamContext" - schema: - $ref: "#/definitions/tapi.oam.OamContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamContext" - parameters: - - in: "body" - name: "tapi.oam.OamContext.body-param" - description: "tapi.oam.OamContext to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamContext" - parameters: - - in: "body" - name: "tapi.oam.OamContext.body-param" - description: "tapi.oam.OamContext to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.OamContext" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/meg={uuid}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.Meg" - parameters: - - name: "uuid" + - name: "local-id" in: "path" - description: "Id of meg" + description: "Id of current-data" required: true type: "string" responses: 200: - description: "tapi.oam.Meg" + description: "tapi.oam.PmDataPac" schema: - $ref: "#/definitions/tapi.oam.Meg" + $ref: "#/definitions/tapi.oam.PmDataPac" 400: description: "Internal error" - /data/context/oam-context/meg={uuid}/mep={local-id}/: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/pm-data-pac/granularity-period/: get: tags: - "tapi-oam" - description: "returns tapi.oam.Mep" + summary: "returns tapi.common.TimePeriod" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of meg" + description: "Id of oam-job" required: true type: "string" - name: "local-id" in: "path" - description: "Id of mep" + description: "Id of current-data" required: true type: "string" responses: 200: - description: "tapi.oam.Mep" + description: "tapi.common.TimePeriod" schema: - $ref: "#/definitions/tapi.oam.Mep" + $ref: "#/definitions/tapi.common.TimePeriod" 400: description: "Internal error" - /data/context/oam-context/meg={uuid}/mep={local-id}/name={value-name}/: - get: + /data/context/oam-context/oam-job={uuid}/name/: + post: tags: - "tapi-oam" - description: "returns tapi.common.NameAndValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mep" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of oam-job" required: true type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/oam-context/meg={uuid}/mip={local-id}/: + 409: + description: "Object already exists" + /data/context/oam-context/oam-job={uuid}/name={value-name}/: get: tags: - "tapi-oam" - description: "returns tapi.oam.Mip" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of meg" + description: "Id of oam-job" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of mip" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.oam.Mip" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.oam.Mip" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/oam-context/meg={uuid}/mip={local-id}/name={value-name}/: - get: + put: tags: - "tapi-oam" - description: "returns tapi.common.NameAndValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mip" + description: "Id of oam-job" required: true type: "string" - name: "value-name" @@ -4731,22 +4686,30 @@ paths: description: "Id of name" required: true type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/oam-context/meg={uuid}/name={value-name}/: - get: + 204: + description: "Object modified" + delete: tags: - "tapi-oam" - description: "returns tapi.common.NameAndValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of meg" + description: "Id of oam-job" required: true type: "string" - name: "value-name" @@ -4755,36 +4718,16 @@ paths: required: true type: "string" responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/oam-context/oam-job/: - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamJob" - parameters: - - in: "body" - name: "tapi.oam.OamJob.body-param" - description: "tapi.oam.OamJob to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamJob" - responses: - 201: - description: "Object created" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-job={uuid}/: + 204: + description: "Object deleted" + /data/context/oam-context/oam-job={uuid}/oam-profile/: get: tags: - "tapi-oam" - description: "returns tapi.oam.OamJob" + summary: "returns tapi.oam.OamProfileRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -4793,15 +4736,16 @@ paths: type: "string" responses: 200: - description: "tapi.oam.OamJob" + description: "tapi.oam.OamProfileRef" schema: - $ref: "#/definitions/tapi.oam.OamJob" + $ref: "#/definitions/tapi.oam.OamProfileRef" 400: description: "Internal error" post: tags: - "tapi-oam" - description: "creates tapi.oam.OamJob" + summary: "creates tapi.oam.OamProfileRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -4809,11 +4753,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.oam.OamJob.body-param" - description: "tapi.oam.OamJob to be added to list" + name: "tapi.oam.OamProfileRef.body-param" + description: "tapi.oam.OamProfileRef to be added to list" required: false schema: - $ref: "#/definitions/tapi.oam.OamJob" + $ref: "#/definitions/tapi.oam.OamProfileRef" responses: 201: description: "Object created" @@ -4824,7 +4768,8 @@ paths: put: tags: - "tapi-oam" - description: "creates or updates tapi.oam.OamJob" + summary: "creates or updates tapi.oam.OamProfileRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -4832,11 +4777,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.oam.OamJob.body-param" - description: "tapi.oam.OamJob to be added or updated" + name: "tapi.oam.OamProfileRef.body-param" + description: "tapi.oam.OamProfileRef to be added or updated" required: false schema: - $ref: "#/definitions/tapi.oam.OamJob" + $ref: "#/definitions/tapi.oam.OamProfileRef" responses: 201: description: "Object created" @@ -4847,7 +4792,8 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.oam.OamJob" + summary: "removes tapi.oam.OamProfileRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -4859,11 +4805,12 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/name/: + /data/context/oam-context/oam-job={uuid}/oam-service-point/: post: tags: - "tapi-oam" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.oam.OamServicePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -4871,11 +4818,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.oam.OamServicePointRef.body-param" + description: "tapi.oam.OamServicePointRef to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.oam.OamServicePointRef" responses: 201: description: "Object created" @@ -4883,98 +4830,88 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/oam-context/oam-job={uuid}/name={value-name}/: + /data/context/oam-context/oam-job={uuid}/oam-service-point={oam-service-uuid},{oam-service-point-local-id}/: get: tags: - "tapi-oam" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.oam.OamServicePointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - name: "value-name" + - name: "oam-service-uuid" in: "path" - description: "Id of name" + description: "Id of oam-service-point" + required: true + type: "string" + - name: "oam-service-point-local-id" + in: "path" + description: "Id of oam-service-point" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.oam.OamServicePointRef" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.oam.OamServicePointRef" 400: description: "Internal error" - post: + put: tags: - "tapi-oam" - description: "creates tapi.common.NameAndValue" + summary: "creates or updates tapi.oam.OamServicePointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - name: "value-name" + - name: "oam-service-uuid" in: "path" - description: "Id of name" + description: "Id of oam-service-point" + required: true + type: "string" + - name: "oam-service-point-local-id" + in: "path" + description: "Id of oam-service-point" required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.oam.OamServicePointRef.body-param" + description: "tapi.oam.OamServicePointRef to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.oam.OamServicePointRef" responses: 201: description: "Object created" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + 204: + description: "Object modified" + delete: tags: - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" + summary: "removes tapi.oam.OamServicePointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" + - name: "oam-service-uuid" in: "path" - description: "Id of oam-job" + description: "Id of oam-service-point" required: true type: "string" - - name: "value-name" + - name: "oam-service-point-local-id" in: "path" - description: "Id of name" + description: "Id of oam-service-point" required: true type: "string" responses: @@ -4982,11 +4919,12 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/oam-profile/: + /data/context/oam-context/oam-job={uuid}/schedule/: get: tags: - "tapi-oam" - description: "returns tapi.oam.OamProfileRef" + summary: "returns tapi.common.TimeRange" + description: "none" parameters: - name: "uuid" in: "path" @@ -4995,15 +4933,16 @@ paths: type: "string" responses: 200: - description: "tapi.oam.OamProfileRef" + description: "tapi.common.TimeRange" schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" + $ref: "#/definitions/tapi.common.TimeRange" 400: description: "Internal error" post: tags: - "tapi-oam" - description: "creates tapi.oam.OamProfileRef" + summary: "creates tapi.common.TimeRange" + description: "none" parameters: - name: "uuid" in: "path" @@ -5011,11 +4950,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.oam.OamProfileRef.body-param" - description: "tapi.oam.OamProfileRef to be added to list" + name: "tapi.common.TimeRange.body-param" + description: "tapi.common.TimeRange to be added to list" required: false schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" + $ref: "#/definitions/tapi.common.TimeRange" responses: 201: description: "Object created" @@ -5026,7 +4965,8 @@ paths: put: tags: - "tapi-oam" - description: "creates or updates tapi.oam.OamProfileRef" + summary: "creates or updates tapi.common.TimeRange" + description: "none" parameters: - name: "uuid" in: "path" @@ -5034,11 +4974,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.oam.OamProfileRef.body-param" - description: "tapi.oam.OamProfileRef to be added or updated" + name: "tapi.common.TimeRange.body-param" + description: "tapi.common.TimeRange to be added or updated" required: false schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" + $ref: "#/definitions/tapi.common.TimeRange" responses: 201: description: "Object created" @@ -5049,7 +4989,8 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.oam.OamProfileRef" + summary: "removes tapi.common.TimeRange" + description: "none" parameters: - name: "uuid" in: "path" @@ -5061,23 +5002,19 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/oam-service-end-point/: + /data/context/oam-context/oam-profile/: post: tags: - "tapi-oam" - description: "creates tapi.oam.OamServiceEndPointRef" + summary: "creates tapi.oam.OamProfile" + description: "none" parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - in: "body" - name: "tapi.oam.OamServiceEndPointRef.body-param" - description: "tapi.oam.OamServiceEndPointRef to be added to list" + name: "tapi.oam.OamProfile.body-param" + description: "tapi.oam.OamProfile to be added to list" required: false schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPointRef" + $ref: "#/definitions/tapi.oam.OamProfile" responses: 201: description: "Object created" @@ -5085,60 +5022,85 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/oam-context/oam-job={uuid}/oam-service-end-point={oam-service-uuid},{oam-service-end-point-local-id}/: + /data/context/oam-context/oam-profile={uuid}/: get: tags: - "tapi-oam" - description: "returns tapi.oam.OamServiceEndPointRef" + summary: "returns tapi.oam.OamProfile" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "oam-service-uuid" - in: "path" - description: "Id of oam-service-end-point" - required: true - type: "string" - - name: "oam-service-end-point-local-id" - in: "path" - description: "Id of oam-service-end-point" + description: "Id of oam-profile" required: true type: "string" responses: 200: - description: "tapi.oam.OamServiceEndPointRef" + description: "tapi.oam.OamProfile" schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPointRef" + $ref: "#/definitions/tapi.oam.OamProfile" 400: description: "Internal error" - post: + put: tags: - "tapi-oam" - description: "creates tapi.oam.OamServiceEndPointRef" + summary: "creates or updates tapi.oam.OamProfile" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of oam-profile" required: true type: "string" - - name: "oam-service-uuid" + - in: "body" + name: "tapi.oam.OamProfile.body-param" + description: "tapi.oam.OamProfile to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamProfile" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.OamProfile" + description: "none" + parameters: + - name: "uuid" in: "path" - description: "Id of oam-service-end-point" + description: "Id of oam-profile" required: true type: "string" - - name: "oam-service-end-point-local-id" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-profile={uuid}/name/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" in: "path" - description: "Id of oam-service-end-point" + description: "Id of oam-profile" required: true type: "string" - in: "body" - name: "tapi.oam.OamServiceEndPointRef.body-param" - description: "tapi.oam.OamServiceEndPointRef to be added to list" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPointRef" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -5146,32 +5108,56 @@ paths: description: "Internal error" 409: description: "Object already exists" - put: + /data/context/oam-context/oam-profile={uuid}/name={value-name}/: + get: tags: - "tapi-oam" - description: "creates or updates tapi.oam.OamServiceEndPointRef" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of oam-profile" required: true type: "string" - - name: "oam-service-uuid" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" in: "path" - description: "Id of oam-service-end-point" + description: "Id of oam-profile" required: true type: "string" - - name: "oam-service-end-point-local-id" + - name: "value-name" in: "path" - description: "Id of oam-service-end-point" + description: "Id of name" required: true type: "string" - in: "body" - name: "tapi.oam.OamServiceEndPointRef.body-param" - description: "tapi.oam.OamServiceEndPointRef to be added or updated" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPointRef" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -5182,21 +5168,19 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.oam.OamServiceEndPointRef" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "oam-service-uuid" - in: "path" - description: "Id of oam-service-end-point" + description: "Id of oam-profile" required: true type: "string" - - name: "oam-service-end-point-local-id" + - name: "value-name" in: "path" - description: "Id of oam-service-end-point" + description: "Id of name" required: true type: "string" responses: @@ -5204,277 +5188,300 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/: - get: + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data/: + post: tags: - "tapi-oam" - description: "returns tapi.oam.PmCurrentData" + summary: "creates tapi.oam.PmThresholdData" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" + description: "Id of oam-profile" required: true type: "string" + - in: "body" + name: "tapi.oam.PmThresholdData.body-param" + description: "tapi.oam.PmThresholdData to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.PmThresholdData" responses: - 200: - description: "tapi.oam.PmCurrentData" - schema: - $ref: "#/definitions/tapi.oam.PmCurrentData" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/elapsed-time/: + 409: + description: "Object already exists" + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/: get: tags: - "tapi-oam" - description: "returns tapi.common.TimeInterval" + summary: "returns tapi.oam.PmThresholdData" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of oam-profile" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" + description: "Id of pm-threshold-data" required: true type: "string" responses: 200: - description: "tapi.common.TimeInterval" + description: "tapi.oam.PmThresholdData" schema: - $ref: "#/definitions/tapi.common.TimeInterval" + $ref: "#/definitions/tapi.oam.PmThresholdData" 400: description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/elapsed-time/period={unit}/: - get: + put: tags: - "tapi-oam" - description: "returns tapi.common.TimePeriod" + summary: "creates or updates tapi.oam.PmThresholdData" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of oam-profile" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "unit" - in: "path" - description: "Id of period" + description: "Id of pm-threshold-data" required: true type: "string" + - in: "body" + name: "tapi.oam.PmThresholdData.body-param" + description: "tapi.oam.PmThresholdData to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.PmThresholdData" responses: - 200: - description: "tapi.common.TimePeriod" - schema: - $ref: "#/definitions/tapi.common.TimePeriod" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/granularity-period/: - get: + 204: + description: "Object modified" + delete: tags: - "tapi-oam" - description: "returns tapi.common.TimePeriod" + summary: "removes tapi.oam.PmThresholdData" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of oam-profile" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" + description: "Id of pm-threshold-data" required: true type: "string" responses: - 200: - description: "tapi.common.TimePeriod" - schema: - $ref: "#/definitions/tapi.common.TimePeriod" 400: description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/name={value-name}/: + 204: + description: "Object deleted" + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/granularity-period/: get: tags: - "tapi-oam" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.TimePeriod" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of oam-profile" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of pm-threshold-data" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.common.TimePeriod" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.common.TimePeriod" 400: description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/: - get: + post: tags: - "tapi-oam" - description: "returns tapi.oam.PmHistoryData" + summary: "creates tapi.common.TimePeriod" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of oam-profile" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" - in: "path" - description: "Id of pm-history-data" + description: "Id of pm-threshold-data" required: true type: "string" + - in: "body" + name: "tapi.common.TimePeriod.body-param" + description: "tapi.common.TimePeriod to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.TimePeriod" responses: - 200: - description: "tapi.oam.PmHistoryData" - schema: - $ref: "#/definitions/tapi.oam.PmHistoryData" + 201: + description: "Object created" 400: description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/granularity-period/ - : get: + 409: + description: "Object already exists" + put: tags: - "tapi-oam" - description: "returns tapi.common.TimePeriod" + summary: "creates or updates tapi.common.TimePeriod" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of oam-profile" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" - in: "path" - description: "Id of pm-history-data" + description: "Id of pm-threshold-data" required: true type: "string" + - in: "body" + name: "tapi.common.TimePeriod.body-param" + description: "tapi.common.TimePeriod to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.TimePeriod" responses: - 200: - description: "tapi.common.TimePeriod" - schema: - $ref: "#/definitions/tapi.common.TimePeriod" + 201: + description: "Object created" 400: description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/name={value-name}/ - : get: + 204: + description: "Object modified" + delete: tags: - "tapi-oam" - description: "returns tapi.common.NameAndValue" + summary: "removes tapi.common.TimePeriod" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of oam-profile" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" + description: "Id of pm-threshold-data" required: true type: "string" - - name: "pm-history-data-local-id" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/name/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" in: "path" - description: "Id of pm-history-data" + description: "Id of oam-profile" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of name" + description: "Id of pm-threshold-data" required: true type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/oam-context/oam-job={uuid}/schedule/: + 409: + description: "Object already exists" + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/name={value-name}/: get: tags: - "tapi-oam" - description: "returns tapi.common.TimeRange" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.common.TimeRange" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.common.TimeRange" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: + put: tags: - "tapi-oam" - description: "creates tapi.common.TimeRange" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of oam-profile" required: true type: "string" - - in: "body" - name: "tapi.common.TimeRange.body-param" - description: "tapi.common.TimeRange to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.TimeRange" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.TimeRange" - parameters: - - name: "uuid" + - name: "local-id" in: "path" - description: "Id of oam-job" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" required: true type: "string" - in: "body" - name: "tapi.common.TimeRange.body-param" - description: "tapi.common.TimeRange to be added or updated" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.TimeRange" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -5485,11 +5492,24 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.common.TimeRange" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" required: true type: "string" responses: @@ -5497,18 +5517,29 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-profile/: + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/threshold-parameter/: post: tags: - "tapi-oam" - description: "creates tapi.oam.OamProfile" + summary: "creates tapi.oam.ThresholdParameter" + description: "none" parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" - in: "body" - name: "tapi.oam.OamProfile.body-param" - description: "tapi.oam.OamProfile to be added to list" + name: "tapi.oam.ThresholdParameter.body-param" + description: "tapi.oam.ThresholdParameter to be added to list" required: false schema: - $ref: "#/definitions/tapi.oam.OamProfile" + $ref: "#/definitions/tapi.oam.ThresholdParameter" responses: 201: description: "Object created" @@ -5516,63 +5547,72 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/: - get: + ? /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/threshold-parameter={pm-parameter-name},{threshold-location}/ + : get: tags: - "tapi-oam" - description: "returns tapi.oam.OamProfile" + summary: "returns tapi.oam.ThresholdParameter" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-profile" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" responses: 200: - description: "tapi.oam.OamProfile" + description: "tapi.oam.ThresholdParameter" schema: - $ref: "#/definitions/tapi.oam.OamProfile" + $ref: "#/definitions/tapi.oam.ThresholdParameter" 400: description: "Internal error" - post: + put: tags: - "tapi-oam" - description: "creates tapi.oam.OamProfile" + summary: "creates or updates tapi.oam.ThresholdParameter" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-profile" required: true type: "string" - - in: "body" - name: "tapi.oam.OamProfile.body-param" - description: "tapi.oam.OamProfile to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamProfile" - parameters: - - name: "uuid" + - name: "local-id" in: "path" - description: "Id of oam-profile" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" required: true type: "string" - in: "body" - name: "tapi.oam.OamProfile.body-param" - description: "tapi.oam.OamProfile to be added or updated" + name: "tapi.oam.ThresholdParameter.body-param" + description: "tapi.oam.ThresholdParameter to be added or updated" required: false schema: - $ref: "#/definitions/tapi.oam.OamProfile" + $ref: "#/definitions/tapi.oam.ThresholdParameter" responses: 201: description: "Object created" @@ -5583,86 +5623,100 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.oam.OamProfile" + summary: "removes tapi.oam.ThresholdParameter" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-profile" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/name/: - post: + ? /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/threshold-parameter={pm-parameter-name},{threshold-location}/pm-parameter-above-thrs/ + : get: tags: - "tapi-oam" - description: "creates tapi.common.NameAndValue" + summary: "returns tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-profile" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" + - name: "local-id" in: "path" - description: "Id of oam-profile" + description: "Id of pm-threshold-data" required: true type: "string" - - name: "value-name" + - name: "pm-parameter-name" in: "path" - description: "Id of name" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.oam.PmParameterValue" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.oam.PmParameterValue" 400: description: "Internal error" post: tags: - "tapi-oam" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-profile" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of name" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.oam.PmParameterValue" responses: 201: description: "Object created" @@ -5673,24 +5727,35 @@ paths: put: tags: - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" + summary: "creates or updates tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-profile" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of name" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.oam.PmParameterValue" responses: 201: description: "Object created" @@ -5701,16 +5766,27 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-profile" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of name" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" required: true type: "string" responses: @@ -5718,57 +5794,45 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-bin-data/: - post: + ? /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/threshold-parameter={pm-parameter-name},{threshold-location}/pm-parameter-below-thrs/ + : get: tags: - "tapi-oam" - description: "creates tapi.oam.PmBinData" + summary: "returns tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-profile" required: true type: "string" - - in: "body" - name: "tapi.oam.PmBinData.body-param" - description: "tapi.oam.PmBinData to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.PmBinData" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/pm-bin-data={local-id}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.PmBinData" - parameters: - - name: "uuid" + - name: "local-id" in: "path" - description: "Id of oam-profile" + description: "Id of pm-threshold-data" required: true type: "string" - - name: "local-id" + - name: "pm-parameter-name" in: "path" - description: "Id of pm-bin-data" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" required: true type: "string" responses: 200: - description: "tapi.oam.PmBinData" + description: "tapi.oam.PmParameterValue" schema: - $ref: "#/definitions/tapi.oam.PmBinData" + $ref: "#/definitions/tapi.oam.PmParameterValue" 400: description: "Internal error" post: tags: - "tapi-oam" - description: "creates tapi.oam.PmBinData" + summary: "creates tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -5777,15 +5841,25 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-bin-data" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" required: true type: "string" - in: "body" - name: "tapi.oam.PmBinData.body-param" - description: "tapi.oam.PmBinData to be added to list" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.oam.PmBinData" + $ref: "#/definitions/tapi.oam.PmParameterValue" responses: 201: description: "Object created" @@ -5796,7 +5870,8 @@ paths: put: tags: - "tapi-oam" - description: "creates or updates tapi.oam.PmBinData" + summary: "creates or updates tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -5805,15 +5880,25 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-bin-data" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" required: true type: "string" - in: "body" - name: "tapi.oam.PmBinData.body-param" - description: "tapi.oam.PmBinData to be added or updated" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.oam.PmBinData" + $ref: "#/definitions/tapi.oam.PmParameterValue" responses: 201: description: "Object created" @@ -5824,7 +5909,8 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.oam.PmBinData" + summary: "removes tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -5833,7 +5919,17 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-bin-data" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" required: true type: "string" responses: @@ -5841,11 +5937,12 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-bin-data={local-id}/granularity-period/: - get: + ? /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/threshold-parameter={pm-parameter-name},{threshold-location}/pm-parameter-clear-thrs/ + : get: tags: - "tapi-oam" - description: "returns tapi.common.TimePeriod" + summary: "returns tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -5854,20 +5951,31 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-bin-data" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" required: true type: "string" responses: 200: - description: "tapi.common.TimePeriod" + description: "tapi.oam.PmParameterValue" schema: - $ref: "#/definitions/tapi.common.TimePeriod" + $ref: "#/definitions/tapi.oam.PmParameterValue" 400: description: "Internal error" post: tags: - "tapi-oam" - description: "creates tapi.common.TimePeriod" + summary: "creates tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -5876,15 +5984,25 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-bin-data" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" required: true type: "string" - in: "body" - name: "tapi.common.TimePeriod.body-param" - description: "tapi.common.TimePeriod to be added to list" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.TimePeriod" + $ref: "#/definitions/tapi.oam.PmParameterValue" responses: 201: description: "Object created" @@ -5895,7 +6013,8 @@ paths: put: tags: - "tapi-oam" - description: "creates or updates tapi.common.TimePeriod" + summary: "creates or updates tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -5904,15 +6023,25 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-bin-data" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" required: true type: "string" - in: "body" - name: "tapi.common.TimePeriod.body-param" - description: "tapi.common.TimePeriod to be added or updated" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.TimePeriod" + $ref: "#/definitions/tapi.oam.PmParameterValue" responses: 201: description: "Object created" @@ -5923,7 +6052,8 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.common.TimePeriod" + summary: "removes tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -5932,7 +6062,17 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-bin-data" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" required: true type: "string" responses: @@ -5940,81 +6080,116 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-bin-data={local-id}/name/: + /data/context/oam-context/oam-service/: post: tags: - "tapi-oam" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.oam.OamService" + description: "none" + parameters: + - in: "body" + name: "tapi.oam.OamService.body-param" + description: "tapi.oam.OamService to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-service={uuid}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.OamService" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-service" required: true type: "string" - - name: "local-id" + responses: + 200: + description: "tapi.oam.OamService" + schema: + $ref: "#/definitions/tapi.oam.OamService" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.OamService" + description: "none" + parameters: + - name: "uuid" in: "path" - description: "Id of pm-bin-data" + description: "Id of oam-service" required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.oam.OamService.body-param" + description: "tapi.oam.OamService to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.oam.OamService" responses: 201: description: "Object created" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/pm-bin-data={local-id}/name={value-name}/: - get: + 204: + description: "Object modified" + delete: tags: - "tapi-oam" - description: "returns tapi.common.NameAndValue" + summary: "removes tapi.oam.OamService" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" + description: "Id of oam-service" required: true type: "string" - - name: "value-name" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-service={uuid}/meg/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.MegRef" + description: "none" + parameters: + - name: "uuid" in: "path" - description: "Id of name" + description: "Id of oam-service" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.oam.MegRef" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.oam.MegRef" 400: description: "Internal error" + /data/context/oam-context/oam-service={uuid}/name/: post: tags: - "tapi-oam" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of oam-service" required: true type: "string" - in: "body" @@ -6030,19 +6205,43 @@ paths: description: "Internal error" 409: description: "Object already exists" - put: + /data/context/oam-context/oam-service={uuid}/name={value-name}/: + get: tags: - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-service" required: true type: "string" - - name: "local-id" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" in: "path" - description: "Id of pm-bin-data" + description: "Id of oam-service" required: true type: "string" - name: "value-name" @@ -6066,16 +6265,14 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" + description: "Id of oam-service" required: true type: "string" - name: "value-name" @@ -6088,23 +6285,24 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data/: + /data/context/oam-context/oam-service={uuid}/oam-service-point/: post: tags: - "tapi-oam" - description: "creates tapi.oam.PmThresholdData" + summary: "creates tapi.oam.OamServicePoint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-service" required: true type: "string" - in: "body" - name: "tapi.oam.PmThresholdData.body-param" - description: "tapi.oam.PmThresholdData to be added to list" + name: "tapi.oam.OamServicePoint.body-param" + description: "tapi.oam.OamServicePoint to be added to list" required: false schema: - $ref: "#/definitions/tapi.oam.PmThresholdData" + $ref: "#/definitions/tapi.oam.OamServicePoint" responses: 201: description: "Object created" @@ -6112,98 +6310,73 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/: + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/: get: tags: - "tapi-oam" - description: "returns tapi.oam.PmThresholdData" + summary: "returns tapi.oam.OamServicePoint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-service-point" required: true type: "string" responses: 200: - description: "tapi.oam.PmThresholdData" + description: "tapi.oam.OamServicePoint" schema: - $ref: "#/definitions/tapi.oam.PmThresholdData" + $ref: "#/definitions/tapi.oam.OamServicePoint" 400: description: "Internal error" - post: + put: tags: - "tapi-oam" - description: "creates tapi.oam.PmThresholdData" + summary: "creates or updates tapi.oam.OamServicePoint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-service-point" required: true type: "string" - in: "body" - name: "tapi.oam.PmThresholdData.body-param" - description: "tapi.oam.PmThresholdData to be added to list" + name: "tapi.oam.OamServicePoint.body-param" + description: "tapi.oam.OamServicePoint to be added or updated" required: false schema: - $ref: "#/definitions/tapi.oam.PmThresholdData" + $ref: "#/definitions/tapi.oam.OamServicePoint" responses: 201: description: "Object created" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + 204: + description: "Object modified" + delete: tags: - "tapi-oam" - description: "creates or updates tapi.oam.PmThresholdData" + summary: "removes tapi.oam.OamServicePoint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.oam.PmThresholdData.body-param" - description: "tapi.oam.PmThresholdData to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.PmThresholdData" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.PmThresholdData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-service-point" required: true type: "string" responses: @@ -6211,50 +6384,53 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/granularity-period/: + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/connectivity-service-end-point/: get: tags: - "tapi-oam" - description: "returns tapi.common.TimePeriod" + summary: "returns tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-service-point" required: true type: "string" responses: 200: - description: "tapi.common.TimePeriod" + description: "tapi.connectivity.ConnectivityServiceEndPointRef" schema: - $ref: "#/definitions/tapi.common.TimePeriod" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" 400: description: "Internal error" post: tags: - "tapi-oam" - description: "creates tapi.common.TimePeriod" + summary: "creates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-service-point" required: true type: "string" - in: "body" - name: "tapi.common.TimePeriod.body-param" - description: "tapi.common.TimePeriod to be added to list" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ to list" required: false schema: - $ref: "#/definitions/tapi.common.TimePeriod" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" responses: 201: description: "Object created" @@ -6265,24 +6441,26 @@ paths: put: tags: - "tapi-oam" - description: "creates or updates tapi.common.TimePeriod" + summary: "creates or updates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-service-point" required: true type: "string" - in: "body" - name: "tapi.common.TimePeriod.body-param" - description: "tapi.common.TimePeriod to be added or updated" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ or updated" required: false schema: - $ref: "#/definitions/tapi.common.TimePeriod" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" responses: 201: description: "Object created" @@ -6293,16 +6471,17 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.common.TimePeriod" + summary: "removes tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-service-point" required: true type: "string" responses: @@ -6310,81 +6489,71 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/name/: - post: + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/mep/: + get: tags: - "tapi-oam" - description: "creates tapi.common.NameAndValue" + summary: "returns tapi.oam.MepRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-service-point" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.oam.MepRef" + schema: + $ref: "#/definitions/tapi.oam.MepRef" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/name={value-name}/: + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/mip/: get: tags: - "tapi-oam" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.oam.MipRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of oam-service-point" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.oam.MipRef" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.oam.MipRef" 400: description: "Internal error" + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/name/: post: tags: - "tapi-oam" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of oam-service-point" required: true type: "string" - in: "body" @@ -6400,19 +6569,23 @@ paths: description: "Internal error" 409: description: "Object already exists" - put: + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/name={value-name}/: + get: tags: - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-service-point" required: true type: "string" - name: "value-name" @@ -6420,32 +6593,29 @@ paths: description: "Id of name" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + put: tags: - "tapi-oam" - description: "removes tapi.common.NameAndValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-service-point" required: true type: "string" - name: "value-name" @@ -6453,102 +6623,40 @@ paths: description: "Id of name" required: true type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-service/: - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamService" - parameters: - in: "body" - name: "tapi.oam.OamService.body-param" - description: "tapi.oam.OamService to be added to list" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.oam.OamService" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-service={uuid}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.OamService" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.OamService" - schema: - $ref: "#/definitions/tapi.oam.OamService" - 400: - description: "Internal error" - post: + 204: + description: "Object modified" + delete: tags: - "tapi-oam" - description: "creates tapi.oam.OamService" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of oam-service" required: true type: "string" - - in: "body" - name: "tapi.oam.OamService.body-param" - description: "tapi.oam.OamService to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamService" - parameters: - - name: "uuid" + - name: "local-id" in: "path" - description: "Id of oam-service" + description: "Id of oam-service-point" required: true type: "string" - - in: "body" - name: "tapi.oam.OamService.body-param" - description: "tapi.oam.OamService to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.OamService" - parameters: - - name: "uuid" + - name: "value-name" in: "path" - description: "Id of oam-service" + description: "Id of name" required: true type: "string" responses: @@ -6556,35 +6664,12 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/end-point/: - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamServiceEndPoint.body-param" - description: "tapi.oam.OamServiceEndPoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/: + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/service-interface-point/: get: tags: - "tapi-oam" - description: "returns tapi.oam.OamServiceEndPoint" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -6593,20 +6678,21 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of oam-service-point" required: true type: "string" responses: 200: - description: "tapi.oam.OamServiceEndPoint" + description: "tapi.common.ServiceInterfacePointRef" schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" 400: description: "Internal error" post: tags: - "tapi-oam" - description: "creates tapi.oam.OamServiceEndPoint" + summary: "creates tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -6615,15 +6701,15 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of oam-service-point" required: true type: "string" - in: "body" - name: "tapi.oam.OamServiceEndPoint.body-param" - description: "tapi.oam.OamServiceEndPoint to be added to list" + name: "tapi.common.ServiceInterfacePointRef.body-param" + description: "tapi.common.ServiceInterfacePointRef to be added to list" required: false schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" responses: 201: description: "Object created" @@ -6634,7 +6720,8 @@ paths: put: tags: - "tapi-oam" - description: "creates or updates tapi.oam.OamServiceEndPoint" + summary: "creates or updates tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -6643,15 +6730,15 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of oam-service-point" required: true type: "string" - in: "body" - name: "tapi.oam.OamServiceEndPoint.body-param" - description: "tapi.oam.OamServiceEndPoint to be added or updated" + name: "tapi.common.ServiceInterfacePointRef.body-param" + description: "tapi.common.ServiceInterfacePointRef to be added or updated" required: false schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" responses: 201: description: "Object created" @@ -6662,7 +6749,8 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.oam.OamServiceEndPoint" + summary: "removes tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -6671,7 +6759,7 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of oam-service-point" required: true type: "string" responses: @@ -6679,51 +6767,33 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/connectivity-service-end-point/: + /data/context/path-computation-context/: get: tags: - - "tapi-oam" - description: "returns tapi.connectivity.ConnectivityServiceEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" + - "tapi-path-computation" + summary: "returns tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" + parameters: [] responses: 200: - description: "tapi.connectivity.ConnectivityServiceEndPointRef" + description: "tapi.path.computation.PathComputationContext" schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" + $ref: "#/definitions/tapi.path.computation.PathComputationContext" 400: description: "Internal error" post: tags: - - "tapi-oam" - description: "creates tapi.connectivity.ConnectivityServiceEndPointRef" + - "tapi-path-computation" + summary: "creates tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - in: "body" - name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" - description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ - \ to list" + name: "tapi.path.computation.PathComputationContext.body-param" + description: "tapi.path.computation.PathComputationContext to be added to\ + \ list" required: false schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" + $ref: "#/definitions/tapi.path.computation.PathComputationContext" responses: 201: description: "Object created" @@ -6733,26 +6803,93 @@ paths: description: "Object already exists" put: tags: - - "tapi-oam" - description: "creates or updates tapi.connectivity.ConnectivityServiceEndPointRef" + - "tapi-path-computation" + summary: "creates or updates tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" + parameters: + - in: "body" + name: "tapi.path.computation.PathComputationContext.body-param" + description: "tapi.path.computation.PathComputationContext to be added or\ + \ updated" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.PathComputationContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.path.computation.PathComputationService" + description: "none" + parameters: + - in: "body" + name: "tapi.path.computation.PathComputationService.body-param" + description: "tapi.path.computation.PathComputationService to be added to\ + \ list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.PathComputationService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.path.computation.PathComputationService" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + responses: + 200: + description: "tapi.path.computation.PathComputationService" + schema: + $ref: "#/definitions/tapi.path.computation.PathComputationService" + 400: + description: "Internal error" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.path.computation.PathComputationService" + description: "none" + parameters: + - name: "uuid" in: "path" - description: "Id of end-point" + description: "Id of path-comp-service" required: true type: "string" - in: "body" - name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" - description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ - \ or updated" + name: "tapi.path.computation.PathComputationService.body-param" + description: "tapi.path.computation.PathComputationService to be added or\ + \ updated" required: false schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" + $ref: "#/definitions/tapi.path.computation.PathComputationService" responses: 201: description: "Object created" @@ -6762,17 +6899,13 @@ paths: description: "Object modified" delete: tags: - - "tapi-oam" - description: "removes tapi.connectivity.ConnectivityServiceEndPointRef" + - "tapi-path-computation" + summary: "removes tapi.path.computation.PathComputationService" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" + description: "Id of path-comp-service" required: true type: "string" responses: @@ -6780,38 +6913,41 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/mep/: - get: + /data/context/path-computation-context/path-comp-service={uuid}/end-point/: + post: tags: - - "tapi-oam" - description: "returns tapi.oam.MepRef" + - "tapi-path-computation" + summary: "creates tapi.path.computation.PathServiceEndPoint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" + description: "Id of path-comp-service" required: true type: "string" + - in: "body" + name: "tapi.path.computation.PathServiceEndPoint.body-param" + description: "tapi.path.computation.PathServiceEndPoint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" responses: - 200: - description: "tapi.oam.MepRef" - schema: - $ref: "#/definitions/tapi.oam.MepRef" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/mip/: + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/: get: tags: - - "tapi-oam" - description: "returns tapi.oam.MipRef" + - "tapi-path-computation" + summary: "returns tapi.path.computation.PathServiceEndPoint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" - name: "local-id" @@ -6821,20 +6957,20 @@ paths: type: "string" responses: 200: - description: "tapi.oam.MipRef" + description: "tapi.path.computation.PathServiceEndPoint" schema: - $ref: "#/definitions/tapi.oam.MipRef" + $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" 400: description: "Internal error" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/name/: - post: + put: tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" + - "tapi-path-computation" + summary: "creates or updates tapi.path.computation.PathServiceEndPoint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" - name: "local-id" @@ -6843,27 +6979,27 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.path.computation.PathServiceEndPoint.body-param" + description: "tapi.path.computation.PathServiceEndPoint to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" responses: 201: description: "Object created" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/name={value-name}/: - get: + 204: + description: "Object modified" + delete: tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" + - "tapi-path-computation" + summary: "removes tapi.path.computation.PathServiceEndPoint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" - name: "local-id" @@ -6871,26 +7007,44 @@ paths: description: "Id of end-point" required: true type: "string" - - name: "value-name" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.Capacity" + description: "none" + parameters: + - name: "uuid" in: "path" - description: "Id of name" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" post: tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" + - "tapi-path-computation" + summary: "creates tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" - name: "local-id" @@ -6898,17 +7052,12 @@ paths: description: "Id of end-point" required: true type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.common.Capacity.body-param" + description: "tapi.common.Capacity to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.common.Capacity" responses: 201: description: "Object created" @@ -6918,12 +7067,13 @@ paths: description: "Object already exists" put: tags: - - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" + - "tapi-path-computation" + summary: "creates or updates tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" - name: "local-id" @@ -6931,17 +7081,12 @@ paths: description: "Id of end-point" required: true type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" + name: "tapi.common.Capacity.body-param" + description: "tapi.common.Capacity to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.common.Capacity" responses: 201: description: "Object created" @@ -6951,12 +7096,13 @@ paths: description: "Object modified" delete: tags: - - "tapi-oam" - description: "removes tapi.common.NameAndValue" + - "tapi-path-computation" + summary: "removes tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" - name: "local-id" @@ -6964,25 +7110,22 @@ paths: description: "Id of end-point" required: true type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/service-interface-point/: + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/total-size/: get: tags: - - "tapi-oam" - description: "returns tapi.common.ServiceInterfacePointRef" + - "tapi-path-computation" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" - name: "local-id" @@ -6992,19 +7135,21 @@ paths: type: "string" responses: 200: - description: "tapi.common.ServiceInterfacePointRef" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" post: tags: - - "tapi-oam" - description: "creates tapi.common.ServiceInterfacePointRef" + - "tapi-path-computation" + summary: "creates tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" - name: "local-id" @@ -7013,11 +7158,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.ServiceInterfacePointRef.body-param" - description: "tapi.common.ServiceInterfacePointRef to be added to list" + name: "tapi.common.CapacityValue.body-param" + description: "tapi.common.CapacityValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + $ref: "#/definitions/tapi.common.CapacityValue" responses: 201: description: "Object created" @@ -7027,12 +7172,14 @@ paths: description: "Object already exists" put: tags: - - "tapi-oam" - description: "creates or updates tapi.common.ServiceInterfacePointRef" + - "tapi-path-computation" + summary: "creates or updates tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" - name: "local-id" @@ -7041,11 +7188,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.ServiceInterfacePointRef.body-param" - description: "tapi.common.ServiceInterfacePointRef to be added or updated" + name: "tapi.common.CapacityValue.body-param" + description: "tapi.common.CapacityValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + $ref: "#/definitions/tapi.common.CapacityValue" responses: 201: description: "Object created" @@ -7055,12 +7202,14 @@ paths: description: "Object modified" delete: tags: - - "tapi-oam" - description: "removes tapi.common.ServiceInterfacePointRef" + - "tapi-path-computation" + summary: "removes tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" - name: "local-id" @@ -7073,33 +7222,23 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/meg/: - get: + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/name/: + post: tags: - - "tapi-oam" - description: "returns tapi.oam.MegRef" + - "tapi-path-computation" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" - responses: - 200: - description: "tapi.oam.MegRef" - schema: - $ref: "#/definitions/tapi.oam.MegRef" - 400: - description: "Internal error" - /data/context/oam-context/oam-service={uuid}/name/: - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" + - name: "local-id" in: "path" - description: "Id of oam-service" + description: "Id of end-point" required: true type: "string" - in: "body" @@ -7115,15 +7254,23 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/oam-context/oam-service={uuid}/name={value-name}/: + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/name={value-name}/: get: tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" + - "tapi-path-computation" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" required: true type: "string" - name: "value-name" @@ -7138,42 +7285,22 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: + put: tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" + - "tapi-path-computation" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of path-comp-service" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" + - name: "local-id" in: "path" - description: "Id of oam-service" + description: "Id of end-point" required: true type: "string" - name: "value-name" @@ -7196,12 +7323,20 @@ paths: description: "Object modified" delete: tags: - - "tapi-oam" - description: "removes tapi.common.NameAndValue" + - "tapi-path-computation" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" required: true type: "string" - name: "value-name" @@ -7214,40 +7349,52 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/oam-profile/: + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/service-interface-point/: get: tags: - - "tapi-oam" - description: "returns tapi.oam.OamProfileRef" + - "tapi-path-computation" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" required: true type: "string" responses: 200: - description: "tapi.oam.OamProfileRef" + description: "tapi.common.ServiceInterfacePointRef" schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" 400: description: "Internal error" post: tags: - - "tapi-oam" - description: "creates tapi.oam.OamProfileRef" + - "tapi-path-computation" + summary: "creates tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" required: true type: "string" - in: "body" - name: "tapi.oam.OamProfileRef.body-param" - description: "tapi.oam.OamProfileRef to be added to list" + name: "tapi.common.ServiceInterfacePointRef.body-param" + description: "tapi.common.ServiceInterfacePointRef to be added to list" required: false schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" responses: 201: description: "Object created" @@ -7257,20 +7404,26 @@ paths: description: "Object already exists" put: tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamProfileRef" + - "tapi-path-computation" + summary: "creates or updates tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" required: true type: "string" - in: "body" - name: "tapi.oam.OamProfileRef.body-param" - description: "tapi.oam.OamProfileRef to be added or updated" + name: "tapi.common.ServiceInterfacePointRef.body-param" + description: "tapi.common.ServiceInterfacePointRef to be added or updated" required: false schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" responses: 201: description: "Object created" @@ -7280,12 +7433,18 @@ paths: description: "Object modified" delete: tags: - - "tapi-oam" - description: "removes tapi.oam.OamProfileRef" + - "tapi-path-computation" + summary: "removes tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" required: true type: "string" responses: @@ -7293,31 +7452,26 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathComputationContext" - parameters: [] - responses: - 200: - description: "tapi.path.computation.PathComputationContext" - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationContext" - 400: - description: "Internal error" + /data/context/path-computation-context/path-comp-service={uuid}/name/: post: tags: - "tapi-path-computation" - description: "creates tapi.path.computation.PathComputationContext" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" - in: "body" - name: "tapi.path.computation.PathComputationContext.body-param" - description: "tapi.path.computation.PathComputationContext to be added to\ - \ list" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.path.computation.PathComputationContext" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -7325,18 +7479,56 @@ paths: description: "Internal error" 409: description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/name={value-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" put: tags: - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathComputationContext" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" - in: "body" - name: "tapi.path.computation.PathComputationContext.body-param" - description: "tapi.path.computation.PathComputationContext to be added or\ - \ updated" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.path.computation.PathComputationContext" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -7347,38 +7539,32 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.path.computation.PathComputationContext" - parameters: [] + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathComputationService" - parameters: - - in: "body" - name: "tapi.path.computation.PathComputationService.body-param" - description: "tapi.path.computation.PathComputationService to be added to\ - \ list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/: + /data/context/path-computation-context/path-comp-service={uuid}/objective-function/: get: tags: - "tapi-path-computation" - description: "returns tapi.path.computation.PathComputationService" + summary: "returns tapi.path.computation.PathObjectiveFunction" + description: "none" parameters: - name: "uuid" in: "path" @@ -7387,15 +7573,16 @@ paths: type: "string" responses: 200: - description: "tapi.path.computation.PathComputationService" + description: "tapi.path.computation.PathObjectiveFunction" schema: - $ref: "#/definitions/tapi.path.computation.PathComputationService" + $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" 400: description: "Internal error" post: tags: - "tapi-path-computation" - description: "creates tapi.path.computation.PathComputationService" + summary: "creates tapi.path.computation.PathObjectiveFunction" + description: "none" parameters: - name: "uuid" in: "path" @@ -7403,12 +7590,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.path.computation.PathComputationService.body-param" - description: "tapi.path.computation.PathComputationService to be added to\ - \ list" + name: "tapi.path.computation.PathObjectiveFunction.body-param" + description: "tapi.path.computation.PathObjectiveFunction to be added to list" required: false schema: - $ref: "#/definitions/tapi.path.computation.PathComputationService" + $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" responses: 201: description: "Object created" @@ -7419,7 +7605,8 @@ paths: put: tags: - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathComputationService" + summary: "creates or updates tapi.path.computation.PathObjectiveFunction" + description: "none" parameters: - name: "uuid" in: "path" @@ -7427,12 +7614,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.path.computation.PathComputationService.body-param" - description: "tapi.path.computation.PathComputationService to be added or\ - \ updated" + name: "tapi.path.computation.PathObjectiveFunction.body-param" + description: "tapi.path.computation.PathObjectiveFunction to be added or updated" required: false schema: - $ref: "#/definitions/tapi.path.computation.PathComputationService" + $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" responses: 201: description: "Object created" @@ -7443,7 +7629,8 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.path.computation.PathComputationService" + summary: "removes tapi.path.computation.PathObjectiveFunction" + description: "none" parameters: - name: "uuid" in: "path" @@ -7455,11 +7642,14 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point/: + /data/context/path-computation-context/path-comp-service={uuid}/objective-function/name/: post: tags: - "tapi-path-computation" - description: "creates tapi.path.computation.PathServiceEndPoint" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -7467,11 +7657,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.path.computation.PathServiceEndPoint.body-param" - description: "tapi.path.computation.PathServiceEndPoint to be added to list" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -7479,78 +7669,56 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/: + /data/context/path-computation-context/path-comp-service={uuid}/objective-function/name={value-name}/: get: tags: - "tapi-path-computation" - description: "returns tapi.path.computation.PathServiceEndPoint" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of end-point" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.path.computation.PathServiceEndPoint" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathServiceEndPoint.body-param" - description: "tapi.path.computation.PathServiceEndPoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" - responses: - 201: - description: "Object created" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathServiceEndPoint" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of end-point" + description: "Id of name" required: true type: "string" - in: "body" - name: "tapi.path.computation.PathServiceEndPoint.body-param" - description: "tapi.path.computation.PathServiceEndPoint to be added or updated" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -7561,16 +7729,19 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.path.computation.PathServiceEndPoint" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of end-point" + description: "Id of name" required: true type: "string" responses: @@ -7578,50 +7749,43 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/: + /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/: get: tags: - "tapi-path-computation" - description: "returns tapi.common.Capacity" + summary: "returns tapi.path.computation.PathOptimizationConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" responses: 200: - description: "tapi.common.Capacity" + description: "tapi.path.computation.PathOptimizationConstraint" schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" 400: description: "Internal error" post: tags: - "tapi-path-computation" - description: "creates tapi.common.Capacity" + summary: "creates tapi.path.computation.PathOptimizationConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - in: "body" - name: "tapi.common.Capacity.body-param" - description: "tapi.common.Capacity to be added to list" + name: "tapi.path.computation.PathOptimizationConstraint.body-param" + description: "tapi.path.computation.PathOptimizationConstraint to be added\ + \ to list" required: false schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" responses: 201: description: "Object created" @@ -7632,24 +7796,21 @@ paths: put: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.Capacity" + summary: "creates or updates tapi.path.computation.PathOptimizationConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - in: "body" - name: "tapi.common.Capacity.body-param" - description: "tapi.common.Capacity to be added or updated" + name: "tapi.path.computation.PathOptimizationConstraint.body-param" + description: "tapi.path.computation.PathOptimizationConstraint to be added\ + \ or updated" required: false schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" responses: 201: description: "Object created" @@ -7660,95 +7821,96 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.common.Capacity" + summary: "removes tapi.path.computation.PathOptimizationConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/: - get: + /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name/: + post: tags: - "tapi-path-computation" - description: "returns tapi.common.BandwidthProfile" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name={value-name}/: + get: tags: - "tapi-path-computation" - description: "creates tapi.common.BandwidthProfile" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of end-point" + description: "Id of name" required: true type: "string" - - in: "body" - name: "tapi.common.BandwidthProfile.body-param" - description: "tapi.common.BandwidthProfile to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" responses: - 201: - description: "Object created" + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.BandwidthProfile" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of end-point" + description: "Id of name" required: true type: "string" - in: "body" - name: "tapi.common.BandwidthProfile.body-param" - description: "tapi.common.BandwidthProfile to be added or updated" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -7759,16 +7921,19 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.common.BandwidthProfile" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of end-point" + description: "Id of name" required: true type: "string" responses: @@ -7776,50 +7941,66 @@ paths: description: "Internal error" 204: description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-burst-size/ - : get: + /data/context/path-computation-context/path-comp-service={uuid}/path={path-uuid}/: + get: tags: - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.path.computation.PathRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "path-uuid" in: "path" - description: "Id of end-point" + description: "Id of path" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.path.computation.PathRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.path.computation.PathRef" 400: description: "Internal error" - post: + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/: + get: tags: - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" + summary: "returns tapi.path.computation.RoutingConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + responses: + 200: + description: "tapi.path.computation.RoutingConstraint" + schema: + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + 400: + description: "Internal error" + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" in: "path" - description: "Id of end-point" + description: "Id of path-comp-service" required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.path.computation.RoutingConstraint.body-param" + description: "tapi.path.computation.RoutingConstraint to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" responses: 201: description: "Object created" @@ -7830,24 +8011,20 @@ paths: put: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.path.computation.RoutingConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.path.computation.RoutingConstraint.body-param" + description: "tapi.path.computation.RoutingConstraint to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" responses: 201: description: "Object created" @@ -7858,95 +8035,93 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.path.computation.RoutingConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" in: "path" - description: "Id of end-point" + description: "Id of path-comp-service" required: true type: "string" + - in: "body" + name: "tapi.topology.CostCharacteristic.body-param" + description: "tapi.topology.CostCharacteristic to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" responses: + 201: + description: "Object created" 400: description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-information-rate/ - : get: + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic={cost-name}/: + get: tags: - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "cost-name" in: "path" - description: "Id of end-point" + description: "Id of cost-characteristic" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.CostCharacteristic" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.CostCharacteristic" 400: description: "Internal error" - post: + put: tags: - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" + summary: "creates or updates tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" + - name: "cost-name" in: "path" - description: "Id of end-point" + description: "Id of cost-characteristic" required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.topology.CostCharacteristic.body-param" + description: "tapi.topology.CostCharacteristic to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.CostCharacteristic" responses: 201: description: "Object created" @@ -7957,16 +8132,18 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "cost-name" in: "path" - description: "Id of end-point" + description: "Id of cost-characteristic" required: true type: "string" responses: @@ -7974,78 +8151,80 @@ paths: description: "Internal error" 204: description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-burst-size/ - : get: + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/latency-characteristic/: + post: tags: - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" + summary: "creates tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" + - in: "body" + name: "tapi.topology.LatencyCharacteristic.body-param" + description: "tapi.topology.LatencyCharacteristic to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + ? /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/ + : get: tags: - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "traffic-property-name" in: "path" - description: "Id of end-point" + description: "Id of latency-characteristic" required: true type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "traffic-property-name" in: "path" - description: "Id of end-point" + description: "Id of latency-characteristic" required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.topology.LatencyCharacteristic.body-param" + description: "tapi.topology.LatencyCharacteristic to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" responses: 201: description: "Object created" @@ -8056,16 +8235,18 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "traffic-property-name" in: "path" - description: "Id of end-point" + description: "Id of latency-characteristic" required: true type: "string" responses: @@ -8073,78 +8254,77 @@ paths: description: "Internal error" 204: description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-information-rate/ - : get: + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/risk-diversity-characteristic/: + post: tags: - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" + summary: "creates tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" + - in: "body" + name: "tapi.topology.RiskCharacteristic.body-param" + description: "tapi.topology.RiskCharacteristic to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + ? /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/ + : get: tags: - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" + summary: "returns tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "risk-characteristic-name" in: "path" - description: "Id of end-point" + description: "Id of risk-diversity-characteristic" required: true type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.topology.RiskCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "risk-characteristic-name" in: "path" - description: "Id of end-point" + description: "Id of risk-diversity-characteristic" required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.topology.RiskCharacteristic.body-param" + description: "tapi.topology.RiskCharacteristic to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.RiskCharacteristic" responses: 201: description: "Object created" @@ -8155,16 +8335,17 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "risk-characteristic-name" in: "path" - description: "Id of end-point" + description: "Id of risk-diversity-characteristic" required: true type: "string" responses: @@ -8172,33 +8353,37 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/total-size/: - get: + /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/: + post: tags: - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" + summary: "creates tapi.path.computation.TopologyConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" + - in: "body" + name: "tapi.path.computation.TopologyConstraint.body-param" + description: "tapi.path.computation.TopologyConstraint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint={local-id}/: + get: tags: - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" + summary: "returns tapi.path.computation.TopologyConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -8207,26 +8392,21 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of topology-constraint" required: true type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.path.computation.TopologyConstraint" + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.path.computation.TopologyConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -8235,15 +8415,15 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of topology-constraint" required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.path.computation.TopologyConstraint.body-param" + description: "tapi.path.computation.TopologyConstraint to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" responses: 201: description: "Object created" @@ -8254,7 +8434,8 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.path.computation.TopologyConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -8263,7 +8444,7 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of topology-constraint" required: true type: "string" responses: @@ -8271,11 +8452,14 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/name/: + /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint={local-id}/name/: post: tags: - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -8284,7 +8468,7 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of topology-constraint" required: true type: "string" - in: "body" @@ -8300,11 +8484,14 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/name={value-name}/: + /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint={local-id}/name={value-name}/: get: tags: - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -8313,7 +8500,7 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of topology-constraint" required: true type: "string" - name: "value-name" @@ -8328,43 +8515,13 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -8373,7 +8530,7 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of topology-constraint" required: true type: "string" - name: "value-name" @@ -8397,7 +8554,10 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -8406,7 +8566,7 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of topology-constraint" required: true type: "string" - name: "value-name" @@ -8419,62 +8579,66 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/service-interface-point/: + /data/context/path-computation-context/path={uuid}/: get: tags: - "tapi-path-computation" - description: "returns tapi.common.ServiceInterfacePointRef" + summary: "returns tapi.path.computation.Path" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" + description: "Id of path" required: true type: "string" responses: 200: - description: "tapi.common.ServiceInterfacePointRef" + description: "tapi.path.computation.Path" schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + $ref: "#/definitions/tapi.path.computation.Path" 400: description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/name/: - post: + /data/context/path-computation-context/path={uuid}/link={topology-uuid},{link-uuid}/: + get: tags: - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" + summary: "returns tapi.topology.LinkRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of path" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.topology.LinkRef" + schema: + $ref: "#/definitions/tapi.topology.LinkRef" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/name={value-name}/: + /data/context/path-computation-context/path={uuid}/name={value-name}/: get: tags: - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of path" required: true type: "string" - name: "value-name" @@ -8489,116 +8653,112 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: + /data/context/path-computation-context/path={uuid}/routing-constraint/: + get: tags: - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" + summary: "returns tapi.path.computation.RoutingConstraint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of path" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.path.computation.RoutingConstraint" + schema: + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + /data/context/path-computation-context/path={uuid}/routing-constraint/cost-characteristic={cost-name}/: + get: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of path" required: true type: "string" - - name: "value-name" + - name: "cost-name" in: "path" - description: "Id of name" + description: "Id of cost-characteristic" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + /data/context/path-computation-context/path={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/: + get: tags: - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of path" required: true type: "string" - - name: "value-name" + - name: "traffic-property-name" in: "path" - description: "Id of name" + description: "Id of latency-characteristic" required: true type: "string" responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/objective-function/: + /data/context/path-computation-context/path={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/: get: tags: - "tapi-path-computation" - description: "returns tapi.path.computation.PathObjectiveFunction" + summary: "returns tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of path" + required: true + type: "string" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-diversity-characteristic" required: true type: "string" responses: 200: - description: "tapi.path.computation.PathObjectiveFunction" + description: "tapi.topology.RiskCharacteristic" schema: - $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" + $ref: "#/definitions/tapi.topology.RiskCharacteristic" 400: description: "Internal error" + /data/context/service-interface-point/: post: tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathObjectiveFunction" + - "tapi-common" + summary: "creates tapi.common.ServiceInterfacePoint" + description: "none" parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - in: "body" - name: "tapi.path.computation.PathObjectiveFunction.body-param" - description: "tapi.path.computation.PathObjectiveFunction to be added to list" + name: "tapi.common.ServiceInterfacePoint.body-param" + description: "tapi.common.ServiceInterfacePoint to be added to list" required: false schema: - $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" responses: 201: description: "Object created" @@ -8606,22 +8766,42 @@ paths: description: "Internal error" 409: description: "Object already exists" + /data/context/service-interface-point={uuid}/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.ServiceInterfacePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.ServiceInterfacePoint" + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + 400: + description: "Internal error" put: tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathObjectiveFunction" + - "tapi-common" + summary: "creates or updates tapi.common.ServiceInterfacePoint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of service-interface-point" required: true type: "string" - in: "body" - name: "tapi.path.computation.PathObjectiveFunction.body-param" - description: "tapi.path.computation.PathObjectiveFunction to be added or updated" + name: "tapi.common.ServiceInterfacePoint.body-param" + description: "tapi.common.ServiceInterfacePoint to be added or updated" required: false schema: - $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" responses: 201: description: "Object created" @@ -8631,12 +8811,13 @@ paths: description: "Object modified" delete: tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.PathObjectiveFunction" + - "tapi-common" + summary: "removes tapi.common.ServiceInterfacePoint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of service-interface-point" required: true type: "string" responses: @@ -8644,66 +8825,57 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/objective-function/name/: - post: + /data/context/service-interface-point={uuid}/available-capacity/: + get: tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" + - "tapi-common" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of service-interface-point" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/objective-function/name={value-name}/: + /data/context/service-interface-point={uuid}/available-capacity/total-size/: get: tags: - - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" + - "tapi-common" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of service-interface-point" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" + /data/context/service-interface-point={uuid}/name/: post: tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" + - "tapi-common" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of service-interface-point" required: true type: "string" - in: "body" @@ -8719,14 +8891,43 @@ paths: description: "Internal error" 409: description: "Object already exists" + /data/context/service-interface-point={uuid}/name={value-name}/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" put: tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" + - "tapi-common" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of service-interface-point" required: true type: "string" - name: "value-name" @@ -8749,12 +8950,15 @@ paths: description: "Object modified" delete: tags: - - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" + - "tapi-common" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of service-interface-point" required: true type: "string" - name: "value-name" @@ -8767,41 +8971,72 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/: + /data/context/service-interface-point={uuid}/total-potential-capacity/: get: tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathOptimizationConstraint" + - "tapi-common" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of service-interface-point" required: true type: "string" responses: 200: - description: "tapi.path.computation.PathOptimizationConstraint" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - post: + /data/context/service-interface-point={uuid}/total-potential-capacity/total-size/: + get: tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathOptimizationConstraint" + - "tapi-common" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of service-interface-point" required: true type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: [] + responses: + 200: + description: "tapi.topology.TopologyContext" + schema: + $ref: "#/definitions/tapi.topology.TopologyContext" + 400: + description: "Internal error" + post: + tags: + - "tapi-topology" + summary: "creates tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: - in: "body" - name: "tapi.path.computation.PathOptimizationConstraint.body-param" - description: "tapi.path.computation.PathOptimizationConstraint to be added\ - \ to list" + name: "tapi.topology.context.TopologyContext.body-param" + description: "tapi.topology.TopologyContext to be added to list" required: false schema: - $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" + $ref: "#/definitions/tapi.topology.TopologyContext" responses: 201: description: "Object created" @@ -8811,21 +9046,16 @@ paths: description: "Object already exists" put: tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathOptimizationConstraint" + - "tapi-topology" + summary: "creates or updates tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - in: "body" - name: "tapi.path.computation.PathOptimizationConstraint.body-param" - description: "tapi.path.computation.PathOptimizationConstraint to be added\ - \ or updated" + name: "tapi.topology.context.TopologyContext.body-param" + description: "tapi.topology.TopologyContext to be added or updated" required: false schema: - $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" + $ref: "#/definitions/tapi.topology.TopologyContext" responses: 201: description: "Object created" @@ -8835,54 +9065,38 @@ paths: description: "Object modified" delete: tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.PathOptimizationConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" + - "tapi-topology" + summary: "removes tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: [] responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name/: - post: + /data/context/topology-context/nw-topology-service/: + get: tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" + - "tapi-topology" + summary: "returns tapi.topology.NetworkTopologyService" + description: "none" + parameters: [] responses: - 201: - description: "Object created" + 200: + description: "tapi.topology.NetworkTopologyService" + schema: + $ref: "#/definitions/tapi.topology.NetworkTopologyService" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name={value-name}/: + /data/context/topology-context/nw-topology-service/name={value-name}/: get: tags: - - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - name: "value-name" in: "path" description: "Id of name" @@ -8895,3239 +9109,297 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: + /data/context/topology-context/nw-topology-service/topology={topology-uuid}/: + get: tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" + - "tapi-topology" + summary: "returns tapi.topology.TopologyRef" + description: "none" parameters: - - name: "uuid" + - name: "topology-uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of topology" required: true type: "string" - - name: "value-name" + responses: + 200: + description: "tapi.topology.TopologyRef" + schema: + $ref: "#/definitions/tapi.topology.TopologyRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.topologycontext.Topology" + description: "none" + parameters: + - name: "uuid" in: "path" - description: "Id of name" + description: "Id of topology" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.topology.Topology" + schema: + $ref: "#/definitions/tapi.topology.Topology" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + /data/context/topology-context/topology={uuid}/boundary-node-edge-point={topology-uuid},{node-uuid},{node-edge-point-uuid}/: + get: tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of topology" required: true type: "string" - - name: "value-name" + - name: "topology-uuid" in: "path" - description: "Id of name" + description: "Id of boundary-node-edge-point" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of boundary-node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of boundary-node-edge-point" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + /data/context/topology-context/topology={uuid}/link={link-uuid}/: + get: tags: - - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" + - "tapi-topology" + summary: "returns tapi.topology.Link" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of topology" required: true type: "string" - - name: "value-name" + - name: "link-uuid" in: "path" - description: "Id of name" + description: "Id of link" required: true type: "string" responses: + 200: + description: "tapi.topology.Link" + schema: + $ref: "#/definitions/tapi.topology.Link" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/path={path-uuid}/: + /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/: get: tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathRef" + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of topology" required: true type: "string" - - name: "path-uuid" + - name: "link-uuid" in: "path" - description: "Id of path" + description: "Id of link" required: true type: "string" responses: 200: - description: "tapi.path.computation.PathRef" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.path.computation.PathRef" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/: + /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/total-size/: get: tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.RoutingConstraint" + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" required: true type: "string" responses: 200: - description: "tapi.path.computation.RoutingConstraint" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - post: + /data/context/topology-context/topology={uuid}/link={link-uuid}/cost-characteristic={cost-name}/: + get: tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.RoutingConstraint" + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" required: true type: "string" - - in: "body" - name: "tapi.path.computation.RoutingConstraint.body-param" - description: "tapi.path.computation.RoutingConstraint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" responses: - 201: - description: "Object created" + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + /data/context/topology-context/topology={uuid}/link={link-uuid}/latency-characteristic={traffic-property-name}/: + get: tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.RoutingConstraint" + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of topology" required: true type: "string" - - in: "body" - name: "tapi.path.computation.RoutingConstraint.body-param" - description: "tapi.path.computation.RoutingConstraint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/latency-characteristic/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - ? /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/ - : get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/risk-diversity-characteristic/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - ? /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/ - : get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.TopologyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.TopologyConstraint" - schema: - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.TopologyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.TopologyConstraint.body-param" - description: "tapi.path.computation.TopologyConstraint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.TopologyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.TopologyConstraint.body-param" - description: "tapi.path.computation.TopologyConstraint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.TopologyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/avoid-topology={topology-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of avoid-topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/exclude-link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LinkRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of exclude-link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of exclude-link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/exclude-node={topology-uuid},{node-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.NodeRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of exclude-node" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of exclude-node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/exclude-path={path-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "path-uuid" - in: "path" - description: "Id of exclude-path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LinkRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of include-link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-node={topology-uuid},{node-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.NodeRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-node" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of include-node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-path={path-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "path-uuid" - in: "path" - description: "Id of include-path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-topology={topology-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.Path" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.Path" - schema: - $ref: "#/definitions/tapi.path.computation.Path" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LinkRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/name={value-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/routing-constraint/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.RoutingConstraint" - schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/routing-constraint/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - /data/context/service-interface-point/: - post: - tags: - - "tapi-common" - description: "creates tapi.common.ServiceInterfacePoint" - parameters: - - in: "body" - name: "tapi.common.ServiceInterfacePoint.body-param" - description: "tapi.common.ServiceInterfacePoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/service-interface-point={uuid}/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.ServiceInterfacePoint" - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.ServiceInterfacePoint.body-param" - description: "tapi.common.ServiceInterfacePoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.ServiceInterfacePoint.body-param" - description: "tapi.common.ServiceInterfacePoint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/service-interface-point={uuid}/available-capacity/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/committed-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/total-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/name/: - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/service-interface-point={uuid}/name={value-name}/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/service-interface-point={uuid}/total-potential-capacity/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/total-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.TopologyContext" - parameters: [] - responses: - 200: - description: "tapi.topology.TopologyContext" - schema: - $ref: "#/definitions/tapi.topology.TopologyContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-topology" - description: "creates tapi.topology.TopologyContext" - parameters: - - in: "body" - name: "tapi.topology.context.TopologyContext.body-param" - description: "tapi.topology.TopologyContext to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.TopologyContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-topology" - description: "creates or updates tapi.topology.TopologyContext" - parameters: - - in: "body" - name: "tapi.topology.context.TopologyContext.body-param" - description: "tapi.topology.TopologyContext to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.TopologyContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-topology" - description: "removes tapi.topology.TopologyContext" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/topology-context/nw-topology-service/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NetworkTopologyService" - parameters: [] - responses: - 200: - description: "tapi.topology.NetworkTopologyService" - schema: - $ref: "#/definitions/tapi.topology.NetworkTopologyService" - 400: - description: "Internal error" - /data/context/topology-context/nw-topology-service/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/topology-context/nw-topology-service/topology={topology-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "topology-uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Topology" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Topology" - schema: - $ref: "#/definitions/tapi.topology.Topology" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Link" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Link" - schema: - $ref: "#/definitions/tapi.topology.Link" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/latency-characteristic={traffic-property-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/node-edge-point={topology-uuid},{node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/resilience-type/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.ResilienceType" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.ResilienceType" - schema: - $ref: "#/definitions/tapi.topology.ResilienceType" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/risk-characteristic={risk-characteristic-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/validation-mechanism={validation-mechanism}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.ValidationMechanism" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "validation-mechanism" - in: "path" - description: "Id of validation-mechanism" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.ValidationMechanism" - schema: - $ref: "#/definitions/tapi.topology.ValidationMechanism" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.topology.Node" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.topology.Node" - schema: - $ref: "#/definitions/tapi.topology.topology.Node" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "aggregated-node-edge-point-node-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/encap-topology/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/latency-characteristic={traffic-property-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroup" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRuleGroup" - schema: - $ref: "#/definitions/tapi.topology.NodeRuleGroup" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/composed-rule-group={topology-uuid},{composed-rule-group-node-uuid},{composed-rule-group-node-rule-group-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroupRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of composed-rule-group" - required: true - type: "string" - - name: "composed-rule-group-node-uuid" - in: "path" - description: "Id of composed-rule-group" - required: true - type: "string" - - name: "composed-rule-group-node-rule-group-uuid" - in: "path" - description: "Id of composed-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRuleGroupRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/cost-characteristic={cost-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.InterRuleGroup" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.InterRuleGroup" - schema: - $ref: "#/definitions/tapi.topology.InterRuleGroup" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/associated-node-rule-group={topology-uuid},{associated-node-rule-group-node-uuid},{associated-node-rule-group-node-rule-group-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroupRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of associated-node-rule-group" - required: true - type: "string" - - name: "associated-node-rule-group-node-uuid" - in: "path" - description: "Id of associated-node-rule-group" - required: true - type: "string" - - name: "associated-node-rule-group-node-rule-group-uuid" - in: "path" - description: "Id of associated-node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRuleGroupRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/cost-characteristic={cost-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" + - name: "link-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of link" required: true type: "string" - - name: "cost-name" + - name: "traffic-property-name" in: "path" - description: "Id of cost-characteristic" + description: "Id of latency-characteristic" required: true type: "string" responses: 200: - description: "tapi.topology.CostCharacteristic" + description: "tapi.topology.LatencyCharacteristic" schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/latency-characteristic={traffic-property-name}/ - : get: + /data/context/topology-context/topology={uuid}/link={link-uuid}/name={value-name}/: + get: tags: - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" + - name: "link-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of link" required: true type: "string" - - name: "traffic-property-name" + - name: "value-name" in: "path" - description: "Id of latency-characteristic" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.topology.LatencyCharacteristic" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/name={value-name}/ + ? /data/context/topology-context/topology={uuid}/link={link-uuid}/node-edge-point={topology-uuid},{node-uuid},{node-edge-point-uuid}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "node-uuid" + - name: "link-uuid" in: "path" - description: "Id of node" + description: "Id of link" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "topology-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "node-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "value-name" + - name: "node-edge-point-uuid" in: "path" - description: "Id of name" + description: "Id of node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.topology.NodeEdgePointRef" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ - : get: + /data/context/topology-context/topology={uuid}/link={link-uuid}/risk-characteristic={risk-characteristic-name}/: + get: tags: - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" + - name: "link-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of link" required: true type: "string" - name: "risk-characteristic-name" @@ -12142,73 +9414,98 @@ paths: $ref: "#/definitions/tapi.topology.RiskCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/ - : get: + /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/: + get: tags: - "tapi-topology" - description: "returns tapi.topology.Rule" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" + - name: "link-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of link" required: true type: "string" - - name: "inter-rule-group-uuid" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/total-size/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of topology" required: true type: "string" - - name: "local-id" + - name: "link-uuid" in: "path" - description: "Id of rule" + description: "Id of link" required: true type: "string" responses: 200: - description: "tapi.topology.Rule" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.topology.Rule" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/name={value-name}/ - : get: + /data/context/topology-context/topology={uuid}/link={link-uuid}/validation-mechanism={validation-mechanism}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.topology.ValidationMechanism" + description: "Provides details of the specific validation mechanism(s) used\ + \ to confirm the presence of an intended topologicalEntity." parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" + - name: "link-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of link" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "validation-mechanism" in: "path" - description: "Id of inter-rule-group" + description: "Id of validation-mechanism" required: true type: "string" - - name: "local-id" + responses: + 200: + description: "tapi.topology.ValidationMechanism" + schema: + $ref: "#/definitions/tapi.topology.ValidationMechanism" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" in: "path" - description: "Id of rule" + description: "Id of topology" required: true type: "string" - name: "value-name" @@ -12223,11 +9520,12 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.Capacity" + summary: "returns tapi.topology.topology.Node" + description: "none" parameters: - name: "uuid" in: "path" @@ -12239,28 +9537,19 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" responses: 200: - description: "tapi.common.Capacity" + description: "tapi.topology.topology.Node" schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.topology.topology.Node" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -12272,28 +9561,34 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "topology-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of aggregated-node-edge-point" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "aggregated-node-edge-point-node-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.topology.NodeEdgePointRef" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" @@ -12305,14 +9600,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/total-size/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of topology" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "node-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of node" required: true type: "string" responses: @@ -12322,11 +9632,13 @@ paths: $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/cost-characteristic={cost-name}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" @@ -12338,28 +9650,24 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" + - name: "cost-name" in: "path" - description: "Id of inter-rule-group" + description: "Id of cost-characteristic" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.CostCharacteristic" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.CostCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/encap-topology/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.TopologyRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -12371,28 +9679,51 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + responses: + 200: + description: "tapi.topology.TopologyRef" + schema: + $ref: "#/definitions/tapi.topology.TopologyRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/latency-characteristic={traffic-property-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of topology" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "node-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of node" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.LatencyCharacteristic" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/name={value-name}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -12404,28 +9735,24 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" + - name: "value-name" in: "path" - description: "Id of inter-rule-group" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/total-size/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.node.NodeEdgePoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -12437,28 +9764,24 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.node.NodeEdgePoint" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.node.NodeEdgePoint" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/latency-characteristic={traffic-property-name}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{aggregated-node-edge-point-node-edge-point-uuid}/ : get: tags: - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -12470,28 +9793,39 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "traffic-property-name" + - name: "topology-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "aggregated-node-edge-point-node-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "aggregated-node-edge-point-node-edge-point-uuid" in: "path" - description: "Id of latency-characteristic" + description: "Id of aggregated-node-edge-point" required: true type: "string" responses: 200: - description: "tapi.topology.LatencyCharacteristic" + description: "tapi.topology.NodeEdgePointRef" schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/name={value-name}/: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-capacity/: get: tags: - "tapi-topology" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" @@ -12503,28 +9837,25 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "value-name" + - name: "node-edge-point-uuid" in: "path" - description: "Id of name" + description: "Id of node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/node-edge-point={topology-uuid},{node-edge-point-node-uuid},{node-edge-point-uuid}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-capacity/total-size/ : get: tags: - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -12536,21 +9867,6 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-edge-point-node-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - name: "node-edge-point-uuid" in: "path" description: "Id of node-edge-point" @@ -12558,16 +9874,17 @@ paths: type: "string" responses: 200: - description: "tapi.topology.NodeEdgePointRef" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-cep-layer-protocol={layer-protocol-qualifier}/ : get: tags: - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" + summary: "returns tapi.topology.NepLayerProtocolCapability" + description: "none" parameters: - name: "uuid" in: "path" @@ -12579,28 +9896,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "risk-characteristic-name" + - name: "layer-protocol-qualifier" in: "path" - description: "Id of risk-characteristic" + description: "Id of available-cep-layer-protocol" required: true type: "string" responses: 200: - description: "tapi.topology.RiskCharacteristic" + description: "tapi.topology.NepLayerProtocolCapability" schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" + $ref: "#/definitions/tapi.topology.NepLayerProtocolCapability" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/: get: tags: - - "tapi-topology" - description: "returns tapi.topology.Rule" + - "tapi-connectivity" + summary: "returns tapi.connectivity.context.topologycontext.topology.node.nodeedgepoint.CepList" + description: "none" parameters: - name: "uuid" in: "path" @@ -12612,28 +9930,24 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "local-id" + - name: "node-edge-point-uuid" in: "path" - description: "Id of rule" + description: "Id of node-edge-point" required: true type: "string" responses: 200: - description: "tapi.topology.Rule" + description: "tapi.connectivity.context.topologycontext.topology.node.nodeedgepoint.CepList" schema: - $ref: "#/definitions/tapi.topology.Rule" + $ref: "#/definitions/tapi.connectivity.context.topologycontext.topology.node.nodeedgepoint.CepList" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/name={value-name}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" + - "tapi-connectivity" + summary: "returns tapi.connectivity.ceplist.ConnectionEndPoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -12645,33 +9959,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "local-id" + - name: "node-edge-point-uuid" in: "path" - description: "Id of rule" + description: "Id of node-edge-point" required: true type: "string" - - name: "value-name" + - name: "connection-end-point-uuid" in: "path" - description: "Id of name" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.connectivity.ceplist.ConnectionEndPoint" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.connectivity.ceplist.ConnectionEndPoint" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/aggregated-connection-end-point={topology-uuid},{aggregated-connection-end-point-node-uuid},{aggregated-connection-end-point-node-edge-point-uuid},{aggregated-connection-end-point-connection-end-point-uuid}/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" + - "tapi-connectivity" + summary: "returns tapi.connectivity.ConnectionEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -12683,51 +9993,49 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" + - name: "connection-end-point-uuid" in: "path" - description: "Id of topology" + description: "Id of connection-end-point" required: true type: "string" - - name: "node-uuid" + - name: "topology-uuid" in: "path" - description: "Id of node" + description: "Id of aggregated-connection-end-point" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "aggregated-connection-end-point-node-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of aggregated-connection-end-point" + required: true + type: "string" + - name: "aggregated-connection-end-point-node-edge-point-uuid" + in: "path" + description: "Id of aggregated-connection-end-point" + required: true + type: "string" + - name: "aggregated-connection-end-point-connection-end-point-uuid" + in: "path" + description: "Id of aggregated-connection-end-point" required: true type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.connectivity.ConnectionEndPointRef" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.connectivity.ConnectionEndPointRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/client-node-edge-point={topology-uuid},{client-node-edge-point-node-uuid},{client-node-edge-point-node-edge-point-uuid}/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" + - "tapi-connectivity" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -12739,23 +10047,44 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of client-node-edge-point" + required: true + type: "string" + - name: "client-node-edge-point-node-uuid" + in: "path" + description: "Id of client-node-edge-point" + required: true + type: "string" + - name: "client-node-edge-point-node-edge-point-uuid" + in: "path" + description: "Id of client-node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.NodeEdgePointRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" + - "tapi-oam" + summary: "returns tapi.oam.MepMipList" + description: "none" parameters: - name: "uuid" in: "path" @@ -12767,23 +10096,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.oam.MepMipList" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.oam.MepMipList" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/mep={meg-uuid},{mep-local-id}/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" + - "tapi-oam" + summary: "returns tapi.oam.MepRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -12795,23 +10130,39 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "meg-uuid" + in: "path" + description: "Id of mep" + required: true + type: "string" + - name: "mep-local-id" + in: "path" + description: "Id of mep" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.oam.MepRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.oam.MepRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/mip={meg-uuid},{mip-local-id}/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" + - "tapi-oam" + summary: "returns tapi.oam.MipRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -12823,23 +10174,41 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "meg-uuid" + in: "path" + description: "Id of mip" + required: true + type: "string" + - name: "mip-local-id" + in: "path" + description: "Id of mip" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.oam.MipRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.oam.MipRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/total-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/name={value-name}/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" + - "tapi-connectivity" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -12851,23 +10220,34 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/: - get: + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/parent-node-edge-point/ + : get: tags: - - "tapi-topology" - description: "returns tapi.topology.node.OwnedNodeEdgePoint" + - "tapi-connectivity" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -12876,26 +10256,34 @@ paths: type: "string" - name: "node-uuid" in: "path" - description: "Id of node" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "connection-end-point-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.topology.node.OwnedNodeEdgePoint" + description: "tapi.topology.NodeEdgePointRef" schema: - $ref: "#/definitions/tapi.topology.node.OwnedNodeEdgePoint" + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/mapped-service-interface-point={service-interface-point-uuid}/ : get: tags: - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "NodeEdgePoint mapped to more than ServiceInterfacePoint (slicing/virtualizing)\ + \ or a ServiceInterfacePoint mapped to more than one NodeEdgePoint (load balancing/Resilience)\ + \ should be considered experimental" parameters: - name: "uuid" in: "path" @@ -12907,38 +10295,31 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "aggregated-node-edge-point-node-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of aggregated-node-edge-point" + description: "Id of node-edge-point" required: true type: "string" - - name: "node-edge-point-uuid" + - name: "service-interface-point-uuid" in: "path" - description: "Id of aggregated-node-edge-point" + description: "Id of mapped-service-interface-point" required: true type: "string" responses: 200: - description: "tapi.topology.NodeEdgePointRef" + description: "tapi.common.ServiceInterfacePointRef" schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/name={value-name}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.Capacity" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -12950,23 +10331,30 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "value-name" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.common.Capacity" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/total-potential-capacity/ : get: tags: - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" @@ -12978,23 +10366,25 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/total-potential-capacity/total-size/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -13006,9 +10396,9 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-edge-point" required: true type: "string" responses: @@ -13018,11 +10408,12 @@ paths: $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.NodeRuleGroup" + description: "none" parameters: - name: "uuid" in: "path" @@ -13034,23 +10425,24 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-rule-group" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.NodeRuleGroup" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.NodeRuleGroup" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" @@ -13062,23 +10454,25 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-rule-group" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/total-size/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -13090,9 +10484,9 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-rule-group" required: true type: "string" responses: @@ -13102,11 +10496,12 @@ paths: $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/total-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/composed-rule-group={topology-uuid},{composed-rule-group-node-uuid},{composed-rule-group-node-rule-group-uuid}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.NodeRuleGroupRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -13118,23 +10513,40 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of composed-rule-group" + required: true + type: "string" + - name: "composed-rule-group-node-uuid" + in: "path" + description: "Id of composed-rule-group" + required: true + type: "string" + - name: "composed-rule-group-node-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of composed-rule-group" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.NodeRuleGroupRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/: - get: + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/cost-characteristic={cost-name}/ + : get: tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.context.topologycontext.topology.node.ownednodeedgepoint.CepList" + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" @@ -13146,23 +10558,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "cost-name" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of cost-characteristic" required: true type: "string" responses: 200: - description: "tapi.connectivity.context.topologycontext.topology.node.ownednodeedgepoint.CepList" + description: "tapi.topology.CostCharacteristic" schema: - $ref: "#/definitions/tapi.connectivity.context.topologycontext.topology.node.ownednodeedgepoint.CepList" + $ref: "#/definitions/tapi.topology.CostCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/ : get: tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ceplist.ConnectionEndPoint" + - "tapi-topology" + summary: "returns tapi.topology.InterRuleGroup" + description: "none" parameters: - name: "uuid" in: "path" @@ -13174,28 +10592,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-rule-group" required: true type: "string" - - name: "connection-end-point-uuid" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of connection-end-point" + description: "Id of inter-rule-group" required: true type: "string" responses: 200: - description: "tapi.connectivity.ceplist.ConnectionEndPoint" + description: "tapi.topology.InterRuleGroup" schema: - $ref: "#/definitions/tapi.connectivity.ceplist.ConnectionEndPoint" + $ref: "#/definitions/tapi.topology.InterRuleGroup" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/aggregated-connection-end-point={topology-uuid},{aggregated-connection-end-point-node-uuid},{node-edge-point-uuid},{aggregated-connection-end-point-connection-end-point-uuid}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/associated-node-rule-group={topology-uuid},{associated-node-rule-group-node-uuid},{associated-node-rule-group-node-rule-group-uuid}/ : get: tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionEndPointRef" + - "tapi-topology" + summary: "returns tapi.topology.NodeRuleGroupRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -13207,48 +10626,44 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-rule-group" required: true type: "string" - - name: "connection-end-point-uuid" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of connection-end-point" + description: "Id of inter-rule-group" required: true type: "string" - name: "topology-uuid" in: "path" - description: "Id of aggregated-connection-end-point" - required: true - type: "string" - - name: "aggregated-connection-end-point-node-uuid" - in: "path" - description: "Id of aggregated-connection-end-point" + description: "Id of associated-node-rule-group" required: true type: "string" - - name: "node-edge-point-uuid" + - name: "associated-node-rule-group-node-uuid" in: "path" - description: "Id of aggregated-connection-end-point" + description: "Id of associated-node-rule-group" required: true type: "string" - - name: "aggregated-connection-end-point-connection-end-point-uuid" + - name: "associated-node-rule-group-node-rule-group-uuid" in: "path" - description: "Id of aggregated-connection-end-point" + description: "Id of associated-node-rule-group" required: true type: "string" responses: 200: - description: "tapi.connectivity.ConnectionEndPointRef" + description: "tapi.topology.NodeRuleGroupRef" schema: - $ref: "#/definitions/tapi.connectivity.ConnectionEndPointRef" + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/client-node-edge-point={topology-uuid},{client-node-edge-point-node-uuid},{node-edge-point-uuid}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/ : get: tags: - - "tapi-connectivity" - description: "returns tapi.topology.NodeEdgePointRef" + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" @@ -13260,43 +10675,30 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of client-node-edge-point" - required: true - type: "string" - - name: "client-node-edge-point-node-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of client-node-edge-point" + description: "Id of node-rule-group" required: true type: "string" - - name: "node-edge-point-uuid" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of client-node-edge-point" + description: "Id of inter-rule-group" required: true type: "string" responses: 200: - description: "tapi.topology.NodeEdgePointRef" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/total-size/ : get: tags: - - "tapi-oam" - description: "returns tapi.oam.MepMipList" + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -13308,28 +10710,30 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-rule-group" required: true type: "string" - - name: "connection-end-point-uuid" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of connection-end-point" + description: "Id of inter-rule-group" required: true type: "string" responses: 200: - description: "tapi.oam.MepMipList" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.oam.MepMipList" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/mep={meg-uuid},{mep-local-id}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/cost-characteristic={cost-name}/ : get: tags: - - "tapi-oam" - description: "returns tapi.oam.MepRef" + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" @@ -13341,38 +10745,35 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of connection-end-point" + description: "Id of node-rule-group" required: true type: "string" - - name: "meg-uuid" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of mep" + description: "Id of inter-rule-group" required: true type: "string" - - name: "mep-local-id" + - name: "cost-name" in: "path" - description: "Id of mep" + description: "Id of cost-characteristic" required: true type: "string" responses: 200: - description: "tapi.oam.MepRef" + description: "tapi.topology.CostCharacteristic" schema: - $ref: "#/definitions/tapi.oam.MepRef" + $ref: "#/definitions/tapi.topology.CostCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/mip={meg-uuid},{mip-local-id}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/latency-characteristic={traffic-property-name}/ : get: tags: - - "tapi-oam" - description: "returns tapi.oam.MipRef" + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" @@ -13384,38 +10785,36 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of connection-end-point" + description: "Id of node-rule-group" required: true type: "string" - - name: "meg-uuid" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of mip" + description: "Id of inter-rule-group" required: true type: "string" - - name: "mip-local-id" + - name: "traffic-property-name" in: "path" - description: "Id of mip" + description: "Id of latency-characteristic" required: true type: "string" responses: 200: - description: "tapi.oam.MipRef" + description: "tapi.topology.LatencyCharacteristic" schema: - $ref: "#/definitions/tapi.oam.MipRef" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/name={value-name}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/name={value-name}/ : get: tags: - - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -13427,14 +10826,14 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-rule-group" required: true type: "string" - - name: "connection-end-point-uuid" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of connection-end-point" + description: "Id of inter-rule-group" required: true type: "string" - name: "value-name" @@ -13449,11 +10848,13 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/parent-node-edge-point/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ : get: tags: - - "tapi-connectivity" - description: "returns tapi.topology.NodeEdgePointRef" + - "tapi-topology" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." parameters: - name: "uuid" in: "path" @@ -13465,28 +10866,34 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-rule-group" required: true type: "string" - - name: "connection-end-point-uuid" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of connection-end-point" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-characteristic" required: true type: "string" responses: 200: - description: "tapi.topology.NodeEdgePointRef" + description: "tapi.topology.RiskCharacteristic" schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + $ref: "#/definitions/tapi.topology.RiskCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/mapped-service-interface-point={service-interface-point-uuid}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.ServiceInterfacePointRef" + summary: "returns tapi.topology.Rule" + description: "none" parameters: - name: "uuid" in: "path" @@ -13498,28 +10905,36 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of inter-rule-group" required: true type: "string" - - name: "service-interface-point-uuid" + - name: "local-id" in: "path" - description: "Id of mapped-service-interface-point" + description: "Id of rule" required: true type: "string" responses: 200: - description: "tapi.common.ServiceInterfacePointRef" + description: "tapi.topology.Rule" schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + $ref: "#/definitions/tapi.topology.Rule" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/name={value-name}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/name={value-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -13531,9 +10946,19 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "local-id" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of rule" required: true type: "string" - name: "value-name" @@ -13548,11 +10973,13 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/ : get: tags: - "tapi-topology" - description: "returns tapi.common.Capacity" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" @@ -13564,9 +10991,14 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of inter-rule-group" required: true type: "string" responses: @@ -13576,11 +11008,13 @@ paths: $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/total-size/ : get: tags: - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -13592,23 +11026,30 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of inter-rule-group" required: true type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/latency-characteristic={traffic-property-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" @@ -13620,23 +11061,31 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "traffic-property-name" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of latency-characteristic" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.LatencyCharacteristic" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/name={value-name}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -13648,23 +11097,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "value-name" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/node-edge-point={topology-uuid},{node-edge-point-node-uuid},{node-edge-point-uuid}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -13676,51 +11131,40 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-rule-group" required: true type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" + - name: "topology-uuid" in: "path" - description: "Id of topology" + description: "Id of node-edge-point" required: true type: "string" - - name: "node-uuid" + - name: "node-edge-point-node-uuid" in: "path" - description: "Id of node" + description: "Id of node-edge-point" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.NodeEdgePointRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/total-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." parameters: - name: "uuid" in: "path" @@ -13732,23 +11176,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "risk-characteristic-name" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of risk-characteristic" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.RiskCharacteristic" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.RiskCharacteristic" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/: get: tags: - "tapi-topology" - description: "returns tapi.common.Capacity" + summary: "returns tapi.topology.Rule" + description: "none" parameters: - name: "uuid" in: "path" @@ -13760,41 +11210,31 @@ paths: description: "Id of node" required: true type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of topology" + description: "Id of node-rule-group" required: true type: "string" - - name: "node-uuid" + - name: "local-id" in: "path" - description: "Id of node" + description: "Id of rule" required: true type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.topology.Rule" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.topology.Rule" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/name={value-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -13806,18 +11246,35 @@ paths: description: "Id of node" required: true type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" @@ -13829,18 +11286,25 @@ paths: description: "Id of node" required: true type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/total-size/ + : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -13852,6 +11316,11 @@ paths: description: "Id of node" required: true type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" responses: 200: description: "tapi.common.CapacityValue" @@ -13859,11 +11328,13 @@ paths: $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" @@ -13877,16 +11348,18 @@ paths: type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/total-size/: get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -13909,6 +11382,8 @@ paths: post: tags: - "tapi-path-computation" + summary: "operates on tapi.path.computation.ComputeP2PPath" + description: "operates on tapi.path.computation.ComputeP2PPath" parameters: - in: "body" name: "tapi.path.computation.computep2ppath.Input.body-param" @@ -13930,6 +11405,8 @@ paths: post: tags: - "tapi-connectivity" + summary: "operates on tapi.connectivity.CreateConnectivityService" + description: "operates on tapi.connectivity.CreateConnectivityService" parameters: - in: "body" name: "tapi.connectivity.createconnectivityservice.Input.body-param" @@ -13951,6 +11428,8 @@ paths: post: tags: - "tapi-notification" + summary: "operates on tapi.notification.CreateNotificationSubscriptionService" + description: "operates on tapi.notification.CreateNotificationSubscriptionService" parameters: - in: "body" name: "tapi.notification.createnotificationsubscriptionservice.Input.body-param" @@ -13972,6 +11451,8 @@ paths: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.CreateOamJob" + description: "operates on tapi.oam.CreateOamJob" parameters: - in: "body" name: "tapi.oam.createoamjob.Input.body-param" @@ -13989,23 +11470,48 @@ paths: description: "No response" 400: description: "Internal error" - /operations/create-oam-service-end-point/: + /operations/create-oam-profile/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.CreateOamProfile" + description: "operates on tapi.oam.CreateOamProfile" + parameters: + - in: "body" + name: "tapi.oam.createoamprofile.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.createoamprofile.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.CreateOamProfile" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/create-oam-service-point/: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.CreateOamServicePoint" + description: "operates on tapi.oam.CreateOamServicePoint" parameters: - in: "body" - name: "tapi.oam.createoamserviceendpoint.Input.body-param" + name: "tapi.oam.createoamservicepoint.Input.body-param" required: false schema: properties: input: - $ref: "#/definitions/tapi.oam.createoamserviceendpoint.Input" + $ref: "#/definitions/tapi.oam.createoamservicepoint.Input" responses: 200: description: "Correct response" schema: - $ref: "#/definitions/tapi.oam.CreateOamServiceEndPoint" + $ref: "#/definitions/tapi.oam.CreateOamServicePoint" 201: description: "No response" 400: @@ -14014,6 +11520,8 @@ paths: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.CreateOamService" + description: "operates on tapi.oam.CreateOamService" parameters: - in: "body" name: "tapi.oam.createoamservice.Input.body-param" @@ -14035,6 +11543,8 @@ paths: post: tags: - "tapi-connectivity" + summary: "operates on tapi.connectivity.DeleteConnectivityService" + description: "operates on tapi.connectivity.DeleteConnectivityService" parameters: - in: "body" name: "tapi.connectivity.deleteconnectivityservice.Input.body-param" @@ -14052,6 +11562,8 @@ paths: post: tags: - "tapi-notification" + summary: "operates on tapi.notification.DeleteNotificationSubscriptionService" + description: "operates on tapi.notification.DeleteNotificationSubscriptionService" parameters: - in: "body" name: "tapi.notification.deletenotificationsubscriptionservice.Input.body-param" @@ -14061,10 +11573,6 @@ paths: input: $ref: "#/definitions/tapi.notification.deletenotificationsubscriptionservice.Input" responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.DeleteNotificationSubscriptionService" 201: description: "No response" 400: @@ -14073,6 +11581,8 @@ paths: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.DeleteOamJob" + description: "operates on tapi.oam.DeleteOamJob" parameters: - in: "body" name: "tapi.oam.deleteoamjob.Input.body-param" @@ -14086,18 +11596,39 @@ paths: description: "No response" 400: description: "Internal error" - /operations/delete-oam-service-end-point/: + /operations/delete-oam-profile/: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.DeleteOamProfile" + description: "operates on tapi.oam.DeleteOamProfile" parameters: - in: "body" - name: "tapi.oam.deleteoamserviceendpoint.Input.body-param" + name: "tapi.oam.deleteoamprofile.Input.body-param" required: false schema: properties: input: - $ref: "#/definitions/tapi.oam.deleteoamserviceendpoint.Input" + $ref: "#/definitions/tapi.oam.deleteoamprofile.Input" + responses: + 201: + description: "No response" + 400: + description: "Internal error" + /operations/delete-oam-service-point/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.DeleteOamServicePoint" + description: "operates on tapi.oam.DeleteOamServicePoint" + parameters: + - in: "body" + name: "tapi.oam.deleteoamservicepoint.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.deleteoamservicepoint.Input" responses: 201: description: "No response" @@ -14107,6 +11638,8 @@ paths: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.DeleteOamService" + description: "operates on tapi.oam.DeleteOamService" parameters: - in: "body" name: "tapi.oam.deleteoamservice.Input.body-param" @@ -14124,6 +11657,8 @@ paths: post: tags: - "tapi-path-computation" + summary: "operates on tapi.path.computation.DeleteP2PPath" + description: "operates on tapi.path.computation.DeleteP2PPath" parameters: - in: "body" name: "tapi.path.computation.deletep2ppath.Input.body-param" @@ -14145,6 +11680,8 @@ paths: post: tags: - "tapi-connectivity" + summary: "operates on tapi.connectivity.GetConnectionDetails" + description: "operates on tapi.connectivity.GetConnectionDetails" parameters: - in: "body" name: "tapi.connectivity.getconnectiondetails.Input.body-param" @@ -14166,6 +11703,8 @@ paths: post: tags: - "tapi-connectivity" + summary: "operates on tapi.connectivity.GetConnectionEndPointDetails" + description: "operates on tapi.connectivity.GetConnectionEndPointDetails" parameters: - in: "body" name: "tapi.connectivity.getconnectionendpointdetails.Input.body-param" @@ -14187,6 +11726,8 @@ paths: post: tags: - "tapi-connectivity" + summary: "operates on tapi.connectivity.GetConnectivityServiceDetails" + description: "operates on tapi.connectivity.GetConnectivityServiceDetails" parameters: - in: "body" name: "tapi.connectivity.getconnectivityservicedetails.Input.body-param" @@ -14222,6 +11763,8 @@ paths: post: tags: - "tapi-topology" + summary: "operates on tapi.topology.GetLinkDetails" + description: "operates on tapi.topology.GetLinkDetails" parameters: - in: "body" name: "tapi.topology.getlinkdetails.Input.body-param" @@ -14243,6 +11786,8 @@ paths: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.GetMeg" + description: "operates on tapi.oam.GetMeg" parameters: - in: "body" name: "tapi.oam.getmeg.Input.body-param" @@ -14264,6 +11809,8 @@ paths: post: tags: - "tapi-topology" + summary: "operates on tapi.topology.GetNodeDetails" + description: "operates on tapi.topology.GetNodeDetails" parameters: - in: "body" name: "tapi.topology.getnodedetails.Input.body-param" @@ -14285,6 +11832,8 @@ paths: post: tags: - "tapi-topology" + summary: "operates on tapi.topology.GetNodeEdgePointDetails" + description: "operates on tapi.topology.GetNodeEdgePointDetails" parameters: - in: "body" name: "tapi.topology.getnodeedgepointdetails.Input.body-param" @@ -14306,6 +11855,8 @@ paths: post: tags: - "tapi-notification" + summary: "operates on tapi.notification.GetNotificationList" + description: "operates on tapi.notification.GetNotificationList" parameters: - in: "body" name: "tapi.notification.getnotificationlist.Input.body-param" @@ -14327,6 +11878,8 @@ paths: post: tags: - "tapi-notification" + summary: "operates on tapi.notification.GetNotificationSubscriptionServiceDetails" + description: "operates on tapi.notification.GetNotificationSubscriptionServiceDetails" parameters: - in: "body" name: "tapi.notification.getnotificationsubscriptionservicedetails.Input.body-param" @@ -14358,10 +11911,26 @@ paths: description: "No response" 400: description: "Internal error" + /operations/get-oam-job-list/: + post: + tags: + - "tapi-oam" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetOamJobList" + 201: + description: "No response" + 400: + description: "Internal error" /operations/get-oam-job/: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.GetOamJob" + description: "operates on tapi.oam.GetOamJob" parameters: - in: "body" name: "tapi.oam.getoamjob.Input.body-param" @@ -14379,37 +11948,76 @@ paths: description: "No response" 400: description: "Internal error" - /operations/get-oam-service-end-point/: + /operations/get-oam-profile-list/: + post: + tags: + - "tapi-oam" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetOamProfileList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-oam-profile/: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.GetOamProfile" + description: "operates on tapi.oam.GetOamProfile" parameters: - in: "body" - name: "tapi.oam.getoamserviceendpoint.Input.body-param" + name: "tapi.oam.getoamprofile.Input.body-param" required: false schema: properties: input: - $ref: "#/definitions/tapi.oam.getoamserviceendpoint.Input" + $ref: "#/definitions/tapi.oam.getoamprofile.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetOamProfile" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-oam-service-list/: + post: + tags: + - "tapi-oam" + parameters: [] responses: 200: description: "Correct response" schema: - $ref: "#/definitions/tapi.oam.GetOamServiceEndPoint" + $ref: "#/definitions/tapi.oam.GetOamServiceList" 201: description: "No response" 400: description: "Internal error" - /operations/get-oam-service-list/: + /operations/get-oam-service-point/: post: tags: - "tapi-oam" - parameters: [] + summary: "operates on tapi.oam.GetOamServicePoint" + description: "operates on tapi.oam.GetOamServicePoint" + parameters: + - in: "body" + name: "tapi.oam.getoamservicepoint.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.getoamservicepoint.Input" responses: 200: description: "Correct response" schema: - $ref: "#/definitions/tapi.oam.GetOamServiceList" + $ref: "#/definitions/tapi.oam.GetOamServicePoint" 201: description: "No response" 400: @@ -14418,6 +12026,8 @@ paths: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.GetOamService" + description: "operates on tapi.oam.GetOamService" parameters: - in: "body" name: "tapi.oam.getoamservice.Input.body-param" @@ -14439,6 +12049,8 @@ paths: post: tags: - "tapi-common" + summary: "operates on tapi.common.GetServiceInterfacePointDetails" + description: "operates on tapi.common.GetServiceInterfacePointDetails" parameters: - in: "body" name: "tapi.common.getserviceinterfacepointdetails.Input.body-param" @@ -14488,6 +12100,8 @@ paths: post: tags: - "tapi-topology" + summary: "operates on tapi.topology.GetTopologyDetails" + description: "operates on tapi.topology.GetTopologyDetails" parameters: - in: "body" name: "tapi.topology.gettopologydetails.Input.body-param" @@ -14523,6 +12137,8 @@ paths: post: tags: - "tapi-path-computation" + summary: "operates on tapi.path.computation.OptimizeP2PPath" + description: "operates on tapi.path.computation.OptimizeP2PPath" parameters: - in: "body" name: "tapi.path.computation.optimizep2ppath.Input.body-param" @@ -14544,6 +12160,8 @@ paths: post: tags: - "tapi-connectivity" + summary: "operates on tapi.connectivity.UpdateConnectivityService" + description: "operates on tapi.connectivity.UpdateConnectivityService" parameters: - in: "body" name: "tapi.connectivity.updateconnectivityservice.Input.body-param" @@ -14565,6 +12183,8 @@ paths: post: tags: - "tapi-notification" + summary: "operates on tapi.notification.UpdateNotificationSubscriptionService" + description: "operates on tapi.notification.UpdateNotificationSubscriptionService" parameters: - in: "body" name: "tapi.notification.updatenotificationsubscriptionservice.Input.body-param" @@ -14586,6 +12206,8 @@ paths: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.UpdateOamJob" + description: "operates on tapi.oam.UpdateOamJob" parameters: - in: "body" name: "tapi.oam.updateoamjob.Input.body-param" @@ -14603,23 +12225,48 @@ paths: description: "No response" 400: description: "Internal error" - /operations/update-oam-service-end-point/: + /operations/update-oam-profile/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.UpdateOamProfile" + description: "operates on tapi.oam.UpdateOamProfile" + parameters: + - in: "body" + name: "tapi.oam.updateoamprofile.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.updateoamprofile.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.UpdateOamProfile" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/update-oam-service-point/: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.UpdateOamServicePoint" + description: "operates on tapi.oam.UpdateOamServicePoint" parameters: - in: "body" - name: "tapi.oam.updateoamserviceendpoint.Input.body-param" + name: "tapi.oam.updateoamservicepoint.Input.body-param" required: false schema: properties: input: - $ref: "#/definitions/tapi.oam.updateoamserviceendpoint.Input" + $ref: "#/definitions/tapi.oam.updateoamservicepoint.Input" responses: 200: description: "Correct response" schema: - $ref: "#/definitions/tapi.oam.UpdateOamServiceEndPoint" + $ref: "#/definitions/tapi.oam.UpdateOamServicePoint" 201: description: "No response" 400: @@ -14628,6 +12275,8 @@ paths: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.UpdateOamService" + description: "operates on tapi.oam.UpdateOamService" parameters: - in: "body" name: "tapi.oam.updateoamservice.Input.body-param" @@ -14649,6 +12298,8 @@ paths: post: tags: - "tapi-common" + summary: "operates on tapi.common.UpdateServiceInterfacePoint" + description: "operates on tapi.common.UpdateServiceInterfacePoint" parameters: - in: "body" name: "tapi.common.updateserviceinterfacepoint.Input.body-param" @@ -14680,45 +12331,9 @@ definitions: enum: - "LOCKED" - "UNLOCKED" - tapi.common.BandwidthProfile: - type: "object" - properties: - committed-information-rate: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - coupling-flag: - type: "boolean" - description: "none" - default: false - bw-profile-type: - description: "none" - $ref: "#/definitions/tapi.common.BandwidthProfileType" - peak-information-rate: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - committed-burst-size: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - peak-burst-size: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - color-aware: - type: "boolean" - description: "none" - default: false - tapi.common.BandwidthProfileType: - type: "string" - enum: - - "MEF_10.x" - - "RFC_2697" - - "RFC_2698" - - "RFC_4115" tapi.common.Capacity: type: "object" properties: - bandwidth-profile: - description: "none" - $ref: "#/definitions/tapi.common.BandwidthProfile" total-size: description: "Total capacity of the TopologicalEntity in MB/s. In case of\ \ bandwidthProfile, this is expected to same as the committedInformationRate." @@ -14760,9 +12375,9 @@ definitions: allOf: - $ref: "#/definitions/tapi.common.TapiContext" - $ref: "#/definitions/tapi.connectivity.ContextAugmentation4" - - $ref: "#/definitions/tapi.notification.ContextAugmentation2" - - $ref: "#/definitions/tapi.oam.ContextAugmentation1" - - $ref: "#/definitions/tapi.path.computation.ContextAugmentation3" + - $ref: "#/definitions/tapi.notification.ContextAugmentation1" + - $ref: "#/definitions/tapi.oam.ContextAugmentation3" + - $ref: "#/definitions/tapi.path.computation.ContextAugmentation2" - $ref: "#/definitions/tapi.topology.ContextAugmentation5" tapi.common.DirectiveValue: type: "string" @@ -14793,21 +12408,21 @@ definitions: properties: name: type: "array" - description: "List of names. A property of an entity with a value that is\ - \ unique in some namespace but may change during the life of the entity.\ - \ A name carries no semantics with respect to the purpose of the entity." + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." items: $ref: "#/definitions/tapi.common.NameAndValue" uuid: type: "string" description: "UUID: An identifier that is universally unique within an identifier\ - \ space, where the identifier space is itself globally unique, and immutable.\ - \ An UUID carries no semantics with respect to the purpose or state of the\ - \ entity.\r\n UUID here uses string representation as\ - \ defined in RFC 4122. The canonical representation uses lowercase characters.\r\ - \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ - \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ - \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a UUID\ + \ in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.common.LayerProtocolName: type: "string" enum: @@ -14828,9 +12443,9 @@ definitions: properties: name: type: "array" - description: "List of names. A property of an entity with a value that is\ - \ unique in some namespace but may change during the life of the entity.\ - \ A name carries no semantics with respect to the purpose of the entity." + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." items: $ref: "#/definitions/tapi.common.NameAndValue" local-id: @@ -14892,7 +12507,7 @@ definitions: $ref: "#/definitions/tapi.common.LayerProtocolName" description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ \ termination and adaptation functions of one or more transport layers. \r\ - \n The structure of LTP supports all transport protocols including\ + \n The structure of LTP supports all transport protocols including\ \ circuit and packet forms." tapi.common.ServiceInterfacePointRef: type: "object" @@ -14926,11 +12541,11 @@ definitions: type: "object" properties: termination-direction: - description: "The overall directionality of the LP. \r\n \ - \ - A BIDIRECTIONAL LP will have some SINK and/or SOURCE flowss.\r\n \ - \ - A SINK LP can only contain elements with SINK flows\ - \ or CONTRA_DIRECTION_SOURCE flows\r\n - A SOURCE LP\ - \ can only contain SOURCE flows or CONTRA_DIRECTION_SINK flows" + description: "The overall directionality of the LP. \r\n -\ + \ A BIDIRECTIONAL LP will have some SINK and/or SOURCE flowss.\r\n \ + \ - A SINK LP can only contain elements with SINK flows or CONTRA_DIRECTION_SOURCE\ + \ flows\r\n - A SOURCE LP can only contain SOURCE flows or\ + \ CONTRA_DIRECTION_SINK flows" $ref: "#/definitions/tapi.common.TerminationDirection" termination-state: description: "Indicates whether the layer is terminated and if so how." @@ -14988,9 +12603,16 @@ definitions: tapi.common.getserviceinterfacepointdetails.Input: type: "object" properties: - sip-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.common.getserviceinterfacepointdetails.Output: type: "object" properties: @@ -15008,9 +12630,16 @@ definitions: tapi.common.updateserviceinterfacepoint.Input: type: "object" properties: - sip-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" state: description: "none" $ref: "#/definitions/tapi.common.AdministrativeState" @@ -15030,11 +12659,11 @@ definitions: description: "An Connection object supports a recursive aggregation relationship\ \ such that the internal construction of an Connection can be exposed\ \ as multiple lower level Connection objects (partitioning).\r\n \ - \ Aggregation is used as for the Node/Topology to allow\ - \ changes in hierarchy. \r\n Connection aggregation\ - \ reflects Node/Topology aggregation. \r\n The FC represents\ - \ a Cross-Connection in an NE. The Cross-Connection in an NE is not necessarily\ - \ the lowest level of FC partitioning." + \ Aggregation is used as for the Node/Topology to allow changes\ + \ in hierarchy. \r\n Connection aggregation reflects Node/Topology\ + \ aggregation. \r\n The FC represents a Cross-Connection\ + \ in an NE. The Cross-Connection in an NE is not necessarily the lowest\ + \ level of FC partitioning." items: $ref: "#/definitions/tapi.connectivity.ConnectionRef" switch-control: @@ -15047,6 +12676,9 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.connectivity.Route" + bounding-node: + description: "none" + $ref: "#/definitions/tapi.topology.NodeRef" layer-protocol-name: description: "none" $ref: "#/definitions/tapi.common.LayerProtocolName" @@ -15060,9 +12692,8 @@ definitions: $ref: "#/definitions/tapi.common.ForwardingDirection" description: "The ForwardingConstruct (FC) object class models enabled potential\ \ for forwarding between two or more LTPs and like the LTP supports any transport\ - \ protocol including all circuit and packet forms.\r\n At the\ - \ lowest level of recursion, a FC represents a cross-connection within an\ - \ NE." + \ protocol including all circuit and packet forms.\r\n At the lowest\ + \ level of recursion, a FC represents a cross-connection within an NE." tapi.connectivity.ConnectionEndPoint: allOf: - $ref: "#/definitions/tapi.common.GlobalClass" @@ -15070,6 +12701,9 @@ definitions: - $ref: "#/definitions/tapi.common.TerminationPac" - type: "object" properties: + protection-role: + description: "none" + $ref: "#/definitions/tapi.connectivity.ProtectionRole" client-node-edge-point: type: "array" description: "none" @@ -15099,7 +12733,7 @@ definitions: $ref: "#/definitions/tapi.common.PortDirection" description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ \ termination and adaptation functions of one or more transport layers. \r\ - \n The structure of LTP supports all transport protocols including\ + \n The structure of LTP supports all transport protocols including\ \ circuit and packet forms." tapi.connectivity.ConnectionEndPointRef: allOf: @@ -15109,7 +12743,7 @@ definitions: connection-end-point-uuid: type: "string" description: "none" - x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:owned-node-edge-point/tapi-connectivity:cep-list/tapi-connectivity:connection-end-point/tapi-connectivity:uuid" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:node-edge-point/tapi-connectivity:cep-list/tapi-connectivity:connection-end-point/tapi-connectivity:uuid" description: "none" tapi.connectivity.ConnectionRef: type: "object" @@ -15121,15 +12755,9 @@ definitions: tapi.connectivity.ConnectivityConstraint: type: "object" properties: - service-layer: - description: "none" - $ref: "#/definitions/tapi.common.LayerProtocolName" schedule: description: "none" $ref: "#/definitions/tapi.common.TimeRange" - connectivity-direction: - description: "none" - $ref: "#/definitions/tapi.common.ForwardingDirection" requested-capacity: description: "none" $ref: "#/definitions/tapi.common.Capacity" @@ -15142,7 +12770,7 @@ definitions: type: "string" description: "An abstract value the meaning of which is mutually agreed \ \ typically represents metrics such as - Class of service, priority, resiliency,\ - \ availability" + \ availability\r\n Class of Service Name." service-type: description: "none" $ref: "#/definitions/tapi.connectivity.ServiceType" @@ -15166,27 +12794,42 @@ definitions: allOf: - $ref: "#/definitions/tapi.common.AdminStatePac" - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" - - $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" - - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - type: "object" properties: + topology-constraint: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" end-point: type: "array" description: "none" items: $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" + resilience-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" connection: type: "array" description: "none" items: $ref: "#/definitions/tapi.connectivity.ConnectionRef" + connectivity-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + direction: + description: "none" + $ref: "#/definitions/tapi.common.ForwardingDirection" description: "The ForwardingConstruct (FC) object class models enabled potential\ \ for forwarding between two or more LTPs and like the LTP supports any transport\ - \ protocol including all circuit and packet forms.\r\n At the\ - \ lowest level of recursion, a FC represents a cross-connection within an\ - \ NE." + \ protocol including all circuit and packet forms.\r\n At the lowest\ + \ level of recursion, a FC represents a cross-connection within an NE." tapi.connectivity.ConnectivityServiceEndPoint: allOf: - $ref: "#/definitions/tapi.common.AdminStatePac" @@ -15205,6 +12848,9 @@ definitions: service-interface-point: description: "none" $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + peer-fwd-connectivity-service-end-point: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" layer-protocol-name: description: "none" $ref: "#/definitions/tapi.common.LayerProtocolName" @@ -15216,23 +12862,29 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.connectivity.ConnectionEndPointRef" + server-connectivity-service-end-point: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" direction: description: "The orientation of defined flow at the EndPoint." $ref: "#/definitions/tapi.common.PortDirection" capacity: description: "none" $ref: "#/definitions/tapi.common.Capacity" + protecting-connectivity-service-end-point: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" description: "The association of the FC to LTPs is made via EndPoints.\r\n \ - \ The EndPoint (EP) object class models the access to the FC\ - \ function. \r\n The traffic forwarding between the associated\ - \ EPs of the FC depends upon the type of FC and may be associated with FcSwitch\ - \ object instances. \r\n In cases where there is resilience\ - \ the EndPoint may convey the resilience role of the access to the FC. \r\n\ - \ It can represent a protected (resilient/reliable) point or\ - \ a protecting (unreliable working or protection) point.\r\n \ - \ The EP replaces the Protection Unit of a traditional protection model.\ - \ \r\n The ForwadingConstruct can be considered as a component\ - \ and the EndPoint as a Port on that component" + \ The EndPoint (EP) object class models the access to the FC function.\ + \ \r\n The traffic forwarding between the associated EPs of the\ + \ FC depends upon the type of FC and may be associated with FcSwitch object\ + \ instances. \r\n In cases where there is resilience the EndPoint\ + \ may convey the resilience role of the access to the FC. \r\n \ + \ It can represent a protected (resilient/reliable) point or a protecting\ + \ (unreliable working or protection) point.\r\n The EP replaces\ + \ the Protection Unit of a traditional protection model. \r\n The\ + \ ForwadingConstruct can be considered as a component and the EndPoint as\ + \ a Port on that component" tapi.connectivity.ConnectivityServiceEndPointRef: allOf: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" @@ -15290,12 +12942,12 @@ definitions: properties: output: $ref: "#/definitions/tapi.connectivity.getconnectivityservicelist.Output" - tapi.connectivity.OwnedNodeEdgePointAugmentation1: + tapi.connectivity.NodeEdgePointAugmentation1: type: "object" properties: cep-list: description: "none" - $ref: "#/definitions/tapi.connectivity.context.topologycontext.topology.node.ownednodeedgepoint.CepList" + $ref: "#/definitions/tapi.connectivity.context.topologycontext.topology.node.nodeedgepoint.CepList" x-augmentation: prefix: "tapi-connectivity" namespace: "urn:onf:otcc:yang:tapi-connectivity" @@ -15314,40 +12966,26 @@ definitions: is-lock-out: type: "boolean" description: "The resource is configured to temporarily not be available for\ - \ use in the protection scheme(s) it is part of.\r\n \ - \ This overrides all other protection control states including forced.\r\ - \n If the item is locked out then it cannot be used under\ - \ any circumstances.\r\n Note: Only relevant when part\ - \ of a protection scheme." + \ use in the protection scheme(s) it is part of.\r\n This\ + \ overrides all other protection control states including forced.\r\n \ + \ If the item is locked out then it cannot be used under any\ + \ circumstances.\r\n Note: Only relevant when part of a protection\ + \ scheme." default: false max-switch-times: type: "integer" format: "int32" description: "Used to limit the maximum swtich times. When work fault disappears\ \ , and traffic return to the original work path, switch counter reset." - restoration-coordinate-type: - description: " The coordination mechanism between multi-layers." - $ref: "#/definitions/tapi.connectivity.CoordinateType" - is-coordinated-switching-both-ends: - type: "boolean" - description: "Is operating such that switching at both ends of each flow acorss\ - \ the FC is coordinated at both ingress and egress ends." - default: false + protection-type: + description: "none" + $ref: "#/definitions/tapi.topology.ProtectionType" hold-off-time: type: "integer" format: "int32" description: "This attribute indicates the time, in milliseconds, between\ \ declaration of signal degrade or signal fail, and the initialization of\ \ the protection switching algorithm." - is-frozen: - type: "boolean" - description: "Temporarily prevents any switch action to be taken and, as such,\ - \ freezes the current state. \r\n Until the freeze is\ - \ cleared, additional near-end external commands are rejected and fault\ - \ condition changes and received APS messages are ignored.\r\n \ - \ All administrative controls of any aspect of protection are\ - \ rejected." - default: false wait-to-revert-time: type: "integer" format: "int32" @@ -15355,9 +12993,9 @@ definitions: \ the time, in minutes, to wait after a fault clears on a higher priority\ \ (preferred) resource before reverting to the preferred resource." default: 15 - resilience-type: - description: "none" - $ref: "#/definitions/tapi.topology.ResilienceType" + selection-control: + description: "Degree of administrative control applied to the switch selection." + $ref: "#/definitions/tapi.connectivity.SelectionControl" preferred-restoration-layer: type: "array" description: "Indicate which layer this resilience parameters package configured\ @@ -15368,6 +13006,28 @@ definitions: type: "integer" format: "int32" description: "none" + restoration-policy: + description: "none" + $ref: "#/definitions/tapi.topology.RestorationPolicy" + restoration-coordinate-type: + description: " The coordination mechanism between multi-layers." + $ref: "#/definitions/tapi.connectivity.CoordinateType" + is-coordinated-switching-both-ends: + type: "boolean" + description: "Is operating such that switching at both ends of each flow acorss\ + \ the FC is coordinated at both ingress and egress ends." + default: false + fault-condition-determination: + type: "string" + description: "none" + is-frozen: + type: "boolean" + description: "Temporarily prevents any switch action to be taken and, as such,\ + \ freezes the current state. \r\n Until the freeze is cleared,\ + \ additional near-end external commands are rejected and fault condition\ + \ changes and received APS messages are ignored.\r\n All\ + \ administrative controls of any aspect of protection are rejected." + default: false reversion-mode: description: "Indcates whether the protection scheme is revertive or non-revertive." $ref: "#/definitions/tapi.connectivity.ReversionMode" @@ -15387,9 +13047,9 @@ definitions: items: $ref: "#/definitions/tapi.connectivity.ConnectionEndPointRef" description: "The FC Route (FcRoute) object class models the individual routes\ - \ of an FC. \r\n The route of an FC object is represented by\ - \ a list of FCs at a lower level. \r\n Note that depending\ - \ on the service supported by an FC, an the FC can have multiple routes." + \ of an FC. \r\n The route of an FC object is represented by a\ + \ list of FCs at a lower level. \r\n Note that depending on the\ + \ service supported by an FC, an the FC can have multiple routes." tapi.connectivity.RouteRef: allOf: - $ref: "#/definitions/tapi.connectivity.ConnectionRef" @@ -15439,9 +13099,6 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.connectivity.RouteRef" - selection-control: - description: "Degree of administrative control applied to the switch selection." - $ref: "#/definitions/tapi.connectivity.SelectionControl" selection-reason: description: "The reason for the current switch selection." $ref: "#/definitions/tapi.connectivity.SelectionReason" @@ -15451,32 +13108,31 @@ definitions: $ref: "#/definitions/tapi.common.PortDirection" description: "The class models the switched forwarding of traffic (traffic flow)\ \ between FcPorts (ConnectionEndPoints) and is present where there is protection\ - \ functionality in the FC (Connection). \r\n If an FC exposes\ - \ protection (having two or more FcPorts that provide alternative identical\ - \ inputs/outputs), the FC will have one or more associated FcSwitch objects\ - \ to represent the alternative flow choices visible at the edge of the FC.\r\ - \n The FC switch represents and defines a protection switch\ - \ structure encapsulated in the FC. \r\n Essentially performs\ - \ one of the functions of the Protection Group in a traditional model. It\ - \ associates to 2 or more FcPorts each playing the role of a Protection Unit.\ - \ \r\n One or more protection, i.e. standby/backup, FcPorts\ - \ provide protection for one or more working (i.e. regular/main/preferred)\ - \ FcPorts where either protection or working can feed one or more protected\ - \ FcPort.\r\n The switch may be used in revertive or non-revertive\ - \ (symmetric) mode. When in revertive mode it may define a waitToRestore time.\r\ - \n It may be used in one of several modes including source\ - \ switch, destination switched, source and destination switched etc (covering\ - \ cases such as 1+1 and 1:1).\r\n It may be locked out (prevented\ - \ from switching), force switched or manual switched.\r\n It\ - \ will indicate switch state and change of state.\r\n The switch\ - \ can be switched away from all sources such that it becomes open and hence\ - \ two coordinated switches can both feed the same LTP so long as at least\ - \ one of the two is switched away from all sources (is 'open').\r\n \ - \ The ability for a Switch to be 'high impedance' allows bidirectional\ - \ ForwardingConstructs to be overlaid on the same bidirectional LTP where\ - \ the appropriate control is enabled to prevent signal conflict.\r\n \ - \ This ability allows multiple alternate routes to be present that\ - \ otherwise would be in conflict." + \ functionality in the FC (Connection). \r\n If an FC exposes protection\ + \ (having two or more FcPorts that provide alternative identical inputs/outputs),\ + \ the FC will have one or more associated FcSwitch objects to represent the\ + \ alternative flow choices visible at the edge of the FC.\r\n The\ + \ FC switch represents and defines a protection switch structure encapsulated\ + \ in the FC. \r\n Essentially performs one of the functions of\ + \ the Protection Group in a traditional model. It associates to 2 or more\ + \ FcPorts each playing the role of a Protection Unit. \r\n One\ + \ or more protection, i.e. standby/backup, FcPorts provide protection for\ + \ one or more working (i.e. regular/main/preferred) FcPorts where either protection\ + \ or working can feed one or more protected FcPort.\r\n The switch\ + \ may be used in revertive or non-revertive (symmetric) mode. When in revertive\ + \ mode it may define a waitToRestore time.\r\n It may be used in\ + \ one of several modes including source switch, destination switched, source\ + \ and destination switched etc (covering cases such as 1+1 and 1:1).\r\n \ + \ It may be locked out (prevented from switching), force switched\ + \ or manual switched.\r\n It will indicate switch state and change\ + \ of state.\r\n The switch can be switched away from all sources\ + \ such that it becomes open and hence two coordinated switches can both feed\ + \ the same LTP so long as at least one of the two is switched away from all\ + \ sources (is 'open').\r\n The ability for a Switch to be 'high\ + \ impedance' allows bidirectional ForwardingConstructs to be overlaid on the\ + \ same bidirectional LTP where the appropriate control is enabled to prevent\ + \ signal conflict.\r\n This ability allows multiple alternate routes\ + \ to be present that otherwise would be in conflict." tapi.connectivity.SwitchControl: allOf: - $ref: "#/definitions/tapi.common.GlobalClass" @@ -15515,7 +13171,7 @@ definitions: allOf: - $ref: "#/definitions/tapi.connectivity.ConnectionEndPoint" - $ref: "#/definitions/tapi.oam.ConnectionEndPointAugmentation1" - tapi.connectivity.context.topologycontext.topology.node.ownednodeedgepoint.CepList: + tapi.connectivity.context.topologycontext.topology.node.nodeedgepoint.CepList: allOf: - type: "object" properties: @@ -15529,8 +13185,10 @@ definitions: type: "object" properties: topology-constraint: + type: "array" description: "none" - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" end-point: type: "array" description: "none" @@ -15539,15 +13197,35 @@ definitions: resilience-constraint: description: "none" $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" routing-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.RoutingConstraint" state: - type: "string" description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" connectivity-constraint: description: "none" $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.connectivity.createconnectivityservice.Output: type: "object" properties: @@ -15557,15 +13235,29 @@ definitions: tapi.connectivity.deleteconnectivityservice.Input: type: "object" properties: - service-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.connectivity.getconnectiondetails.Input: type: "object" properties: - connection-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.connectivity.getconnectiondetails.Output: type: "object" properties: @@ -15575,18 +13267,16 @@ definitions: tapi.connectivity.getconnectionendpointdetails.Input: type: "object" properties: - cep-id-or-name: - type: "string" - description: "none" - nep-id-or-name: - type: "string" - description: "none" - node-id-or-name: - type: "string" - description: "none" - topology-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.connectivity.getconnectionendpointdetails.Output: type: "object" properties: @@ -15596,9 +13286,16 @@ definitions: tapi.connectivity.getconnectivityservicedetails.Input: type: "object" properties: - service-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.connectivity.getconnectivityservicedetails.Output: type: "object" properties: @@ -15616,12 +13313,11 @@ definitions: tapi.connectivity.updateconnectivityservice.Input: type: "object" properties: - service-id-or-name: - type: "string" - description: "none" topology-constraint: + type: "array" description: "none" - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" end-point: type: "array" description: "none" @@ -15630,43 +13326,44 @@ definitions: resilience-constraint: description: "none" $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" routing-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.RoutingConstraint" state: - type: "string" description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" connectivity-constraint: description: "none" $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.connectivity.updateconnectivityservice.Output: type: "object" properties: service: description: "none" $ref: "#/definitions/tapi.connectivity.ConnectivityService" - tapi.notification.AlarmInfo: - type: "object" - properties: - perceived-severity: - description: "none" - $ref: "#/definitions/tapi.notification.PerceivedSeverityType" - probable-cause: - type: "string" - description: "none" - service-affecting: - description: "none" - $ref: "#/definitions/tapi.notification.ServiceAffecting" - is-transient: - type: "boolean" - description: "none" - default: false - tapi.notification.ContextAugmentation2: + tapi.notification.ContextAugmentation1: type: "object" properties: notification-context: description: "Augments the base TAPI Context with NotificationService information" - $ref: "#/definitions/tapi.notification.NotificationContext" + $ref: "#/definitions/tapi.notification.context.NotificationContext" x-augmentation: prefix: "tapi-notification" namespace: "urn:onf:otcc:yang:tapi-notification" @@ -15675,11 +13372,6 @@ definitions: properties: output: $ref: "#/definitions/tapi.notification.createnotificationsubscriptionservice.Output" - tapi.notification.DeleteNotificationSubscriptionService: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.notification.deletenotificationsubscriptionservice.Output" tapi.notification.GetNotificationList: type: "object" properties: @@ -15718,8 +13410,8 @@ definitions: - type: "object" properties: target-object-type: + type: "string" description: "none" - $ref: "#/definitions/tapi.notification.ObjectType" additional-text: type: "string" description: "none" @@ -15735,18 +13427,15 @@ definitions: type: "integer" format: "int32" description: "A monotonous increasing sequence number associated with the\ - \ notification.\r\n The exact semantics of how this\ - \ sequence number is assigned (per channel or subscription or source or\ - \ system) is left undefined." - tca-info: - description: "none" - $ref: "#/definitions/tapi.notification.TcaInfo" + \ notification.\r\n The exact semantics of how this sequence\ + \ number is assigned (per channel or subscription or source or system)\ + \ is left undefined." target-object-identifier: type: "string" description: "none" notification-type: + type: "string" description: "none" - $ref: "#/definitions/tapi.notification.NotificationType" target-object-name: type: "array" description: "none" @@ -15758,9 +13447,9 @@ definitions: source-indicator: description: "none" $ref: "#/definitions/tapi.notification.SourceIndicator" - alarm-info: + layer-protocol-qualifier: + type: "string" description: "none" - $ref: "#/definitions/tapi.notification.AlarmInfo" changed-attributes: type: "array" description: "none" @@ -15780,23 +13469,10 @@ definitions: stream-address: type: "string" description: "The address/location/URI of the channel/stream to which the\ - \ subscribed notifications are published.\r\n This\ - \ specifics of this is typically dependent on the implementation protocol\ - \ & mechanism and hence is typed as a string." + \ subscribed notifications are published.\r\n This specifics\ + \ of this is typically dependent on the implementation protocol & mechanism\ + \ and hence is typed as a string." description: "none" - tapi.notification.NotificationContext: - type: "object" - properties: - notif-subscription: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - notification: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.Notification" tapi.notification.NotificationSubscriptionService: allOf: - $ref: "#/definitions/tapi.common.GlobalClass" @@ -15817,68 +13493,16 @@ definitions: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.ObjectType" + type: "string" supported-notification-types: type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.NotificationType" - subscription-filter: - description: "none" - $ref: "#/definitions/tapi.notification.SubscriptionFilter" - description: "none" - tapi.notification.NotificationType: - type: "string" - enum: - - "OBJECT_CREATION" - - "OBJECT_DELETION" - - "ATTRIBUTE_VALUE_CHANGE" - - "ALARM_EVENT" - - "THRESHOLD_CROSSING_ALERT" - tapi.notification.ObjectType: - type: "string" - enum: - - "TOPOLOGY" - - "NODE" - - "LINK" - - "CONNECTION" - - "PATH" - - "CONNECTIVITY_SERVICE" - - "VIRTUAL_NETWORK_SERVICE" - - "PATH_COMPUTATION_SERVICE" - - "NODE_EDGE_POINT" - - "SERVICE_INTERFACE_POINT" - - "CONNECTION_END_POINT" - - "MAINTENANCE_ENTITY_GROUP" - - "MAINTENANCE_ENTITY" - - "MEG_END_POINT" - - "MEG_INTERMEDIATE_POINT" - - "SWITCH_CONTROL" - - "SWITCH" - - "ROUTE" - - "NODE_RULE_GROUP" - - "INTER_RULE_GROUP" - - "RULE" - - "OAM_JOB" - tapi.notification.PerceivedSeverityType: - type: "string" - enum: - - "CRITICAL" - - "MAJOR" - - "MINOR" - - "WARNING" - - "CLEARED" - tapi.notification.PerceivedTcaSeverity: - type: "string" - enum: - - "WARNING" - - "CLEAR" - tapi.notification.ServiceAffecting: - type: "string" - enum: - - "SERVICE_AFFECTING" - - "NOT_SERVICE_AFFECTING" - - "UNKNOWN" + description: "none" + items: + type: "string" + subscription-filter: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + description: "none" tapi.notification.SourceIndicator: type: "string" enum: @@ -15894,7 +13518,7 @@ definitions: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.NotificationType" + type: "string" requested-object-identifier: type: "array" description: "none" @@ -15915,57 +13539,56 @@ definitions: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.ObjectType" + type: "string" description: "none" tapi.notification.SubscriptionState: type: "string" enum: - "SUSPENDED" - "ACTIVE" - tapi.notification.TcaInfo: - type: "object" - properties: - threshold-crossing: - description: "none" - $ref: "#/definitions/tapi.notification.ThresholdCrossingType" - threshold-parameter: - type: "string" - description: "none" - is-transient: - type: "boolean" - description: "none" - default: false - threshold-value: - type: "integer" - format: "int32" - description: "none" - perceived-severity: - description: "none" - $ref: "#/definitions/tapi.notification.PerceivedTcaSeverity" - suspect-interval-flag: - type: "boolean" - description: "none" - default: false - measurement-interval: - type: "string" - description: "none" - tapi.notification.ThresholdCrossingType: - type: "string" - enum: - - "THRESHOLD_ABOVE" - - "THRESHOLD_BELOW" - - "CLEARED" tapi.notification.UpdateNotificationSubscriptionService: type: "object" properties: output: $ref: "#/definitions/tapi.notification.updatenotificationsubscriptionservice.Output" + tapi.notification.context.NotificationContext: + allOf: + - type: "object" + properties: + notif-subscription: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + notification: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.notificationcontext.Notification" + description: "Augments the base TAPI Context with NotificationService information" tapi.notification.createnotificationsubscriptionservice.Input: type: "object" properties: subscription-state: description: "none" $ref: "#/definitions/tapi.notification.SubscriptionState" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" subscription-filter: description: "none" $ref: "#/definitions/tapi.notification.SubscriptionFilter" @@ -15978,24 +13601,33 @@ definitions: tapi.notification.deletenotificationsubscriptionservice.Input: type: "object" properties: - subscription-id-or-name: + uuid: type: "string" - description: "none" - tapi.notification.deletenotificationsubscriptionservice.Output: - type: "object" - properties: - subscription-service: - description: "none" - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.notification.getnotificationlist.Input: type: "object" properties: - time-period: - type: "string" - description: "none" - subscription-id-or-name: - type: "string" + time-range: description: "none" + $ref: "#/definitions/tapi.common.TimeRange" + subscription-id: + type: "string" + description: "UUID of the associated Notification Subscription Service: An\ + \ identifier that is universally unique within an identifier space, where\ + \ the identifier space is itself globally unique, and immutable.\r\n \ + \ An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.notification.getnotificationlist.Output: type: "object" properties: @@ -16003,13 +13635,20 @@ definitions: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.Notification" + $ref: "#/definitions/tapi.notification.notificationcontext.Notification" tapi.notification.getnotificationsubscriptionservicedetails.Input: type: "object" properties: - subscription-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.notification.getnotificationsubscriptionservicedetails.Output: type: "object" properties: @@ -16031,30 +13670,65 @@ definitions: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.ObjectType" + type: "string" supported-notification-types: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.NotificationType" + type: "string" + tapi.notification.notificationcontext.Notification: + allOf: + - $ref: "#/definitions/tapi.notification.Notification" + - $ref: "#/definitions/tapi.oam.NotificationAugmentation1" + - $ref: "#/definitions/tapi.oam.NotificationAugmentation2" tapi.notification.updatenotificationsubscriptionservice.Input: type: "object" properties: subscription-state: description: "none" $ref: "#/definitions/tapi.notification.SubscriptionState" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" subscription-filter: description: "none" $ref: "#/definitions/tapi.notification.SubscriptionFilter" - subscription-id-or-name: - type: "string" - description: "none" tapi.notification.updatenotificationsubscriptionservice.Output: type: "object" properties: subscription-service: description: "none" $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + tapi.oam.AlarmInfo: + type: "object" + properties: + perceived-severity: + description: "none" + $ref: "#/definitions/tapi.oam.PerceivedSeverityType" + probable-cause: + type: "string" + description: "none" + service-affecting: + description: "none" + $ref: "#/definitions/tapi.oam.ServiceAffecting" + is-transient: + type: "boolean" + description: "none" + default: false tapi.oam.ConnectionEndPointAugmentation1: type: "object" properties: @@ -16064,7 +13738,7 @@ definitions: x-augmentation: prefix: "tapi-oam" namespace: "urn:onf:otcc:yang:tapi-oam" - tapi.oam.ContextAugmentation1: + tapi.oam.ContextAugmentation3: type: "object" properties: oam-context: @@ -16078,16 +13752,47 @@ definitions: properties: output: $ref: "#/definitions/tapi.oam.createoamjob.Output" + tapi.oam.CreateOamProfile: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.createoamprofile.Output" tapi.oam.CreateOamService: type: "object" properties: output: $ref: "#/definitions/tapi.oam.createoamservice.Output" - tapi.oam.CreateOamServiceEndPoint: + tapi.oam.CreateOamServicePoint: type: "object" properties: output: - $ref: "#/definitions/tapi.oam.createoamserviceendpoint.Output" + $ref: "#/definitions/tapi.oam.createoamservicepoint.Output" + tapi.oam.CurrentData: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + elapsed-time: + description: "none" + $ref: "#/definitions/tapi.common.TimeInterval" + period-start-time: + type: "string" + description: "This attribute indicates the start of the current monitoring\ + \ interval.\r\n The value is bound to the quarter of an\ + \ hour in case of a 15 minute interval and bound to the hour in case of\ + \ a 24 hour interval." + pm-data-pac: + description: "none" + $ref: "#/definitions/tapi.oam.PmDataPac" + history-data: + type: "array" + description: "in case of 24hr Current Data, at least 1 History Data.\r\n\ + \ In case of 15min Current Data, at least 16 History Data.\r\ + \n In case of <15min, the number of History Data shall\ + \ be able to cover a span of 4 hours." + items: + $ref: "#/definitions/tapi.oam.HistoryData" + description: "none" tapi.oam.GetMeg: type: "object" properties: @@ -16098,53 +13803,75 @@ definitions: properties: output: $ref: "#/definitions/tapi.oam.getoamjob.Output" - tapi.oam.GetOamService: + tapi.oam.GetOamJobList: type: "object" properties: output: - $ref: "#/definitions/tapi.oam.getoamservice.Output" - tapi.oam.GetOamServiceEndPoint: + $ref: "#/definitions/tapi.oam.getoamjoblist.Output" + tapi.oam.GetOamProfile: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getoamprofile.Output" + tapi.oam.GetOamProfileList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getoamprofilelist.Output" + tapi.oam.GetOamService: type: "object" properties: output: - $ref: "#/definitions/tapi.oam.getoamserviceendpoint.Output" + $ref: "#/definitions/tapi.oam.getoamservice.Output" tapi.oam.GetOamServiceList: type: "object" properties: output: $ref: "#/definitions/tapi.oam.getoamservicelist.Output" - tapi.oam.Meg: + tapi.oam.GetOamServicePoint: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getoamservicepoint.Output" + tapi.oam.HistoryData: allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.common.OperationalStatePac" + - $ref: "#/definitions/tapi.common.LocalClass" - type: "object" properties: - meg-identifier: + period-start-time: type: "string" + description: "This attribute indicates the start of the monitoring interval.\r\ + \n The value is bound to the quarter of an hour in case\ + \ of a 15 minute interval and bound to the hour in case of a 24 hour interval." + pm-data-pac: description: "none" - meg-level: - type: "integer" - format: "int32" + $ref: "#/definitions/tapi.oam.PmDataPac" + period-end-time: + type: "string" description: "none" - mip: - type: "array" - description: "ME may 0, 1, or more MIPs" - items: - $ref: "#/definitions/tapi.oam.Mip" + description: "none" + tapi.oam.Meg: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.common.OperationalStatePac" + - type: "object" + properties: layer-protocol-name: description: "none" $ref: "#/definitions/tapi.common.LayerProtocolName" mep: type: "array" description: "1. ME may have 0 MEPs (case of transit domains where at least\ - \ 1 MIP is present)\r\n 2. ME may have 1 MEP (case\ - \ of edge domaind, where the peer MEP is ouside the managed domain)\r\n\ - \ 3. ME may have 2 MEPs" + \ 1 MIP is present)\r\n 2. ME may have 1 MEP (case of edge\ + \ domaind, where the peer MEP is ouside the managed domain)\r\n \ + \ 3. ME may have 2 MEPs" items: $ref: "#/definitions/tapi.oam.Mep" - direction: - description: "none" - $ref: "#/definitions/tapi.common.ForwardingDirection" + mip: + type: "array" + description: "ME may 0, 1, or more MIPs" + items: + $ref: "#/definitions/tapi.oam.Mip" description: "none" tapi.oam.MegRef: type: "object" @@ -16162,17 +13889,6 @@ definitions: layer-protocol-name: description: "none" $ref: "#/definitions/tapi.common.LayerProtocolName" - peer-mep-identifier: - type: "array" - description: "none" - items: - type: "string" - mep-identifier: - type: "string" - description: "none" - direction: - description: "none" - $ref: "#/definitions/tapi.common.TerminationDirection" description: "none" tapi.oam.MepMipList: type: "object" @@ -16216,19 +13932,24 @@ definitions: description: "none" x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:meg/tapi-oam:mip/tapi-oam:local-id" description: "none" - tapi.oam.OamConstraint: + tapi.oam.NotificationAugmentation1: type: "object" properties: - layer-protocol-name: - description: "none" - $ref: "#/definitions/tapi.common.LayerProtocolName" - meg-level: - type: "integer" - format: "int32" + alarm-info: description: "none" - direction: + $ref: "#/definitions/tapi.oam.AlarmInfo" + x-augmentation: + prefix: "tapi-oam" + namespace: "urn:onf:otcc:yang:tapi-oam" + tapi.oam.NotificationAugmentation2: + type: "object" + properties: + tca-info: description: "none" - $ref: "#/definitions/tapi.common.ForwardingDirection" + $ref: "#/definitions/tapi.oam.TcaInfo" + x-augmentation: + prefix: "tapi-oam" + namespace: "urn:onf:otcc:yang:tapi-oam" tapi.oam.OamContext: type: "object" properties: @@ -16264,27 +13985,34 @@ definitions: oam-profile: description: "none" $ref: "#/definitions/tapi.oam.OamProfileRef" - pm-current-data: - type: "array" - description: "Granularity period of the CurrentData identifies the specific\ - \ CurrentData instance in the scope of this OamJob.\r\n \ - \ For example, typically at least\r\n one 15min\ - \ and\r\n one 24hr;\r\n optionally\ - \ one additional configurable (< 15min)" - items: - $ref: "#/definitions/tapi.oam.PmCurrentData" creation-time: type: "string" description: "none" - oam-service-end-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamServiceEndPointRef" oam-job-type: type: "string" description: "none" + oam-service-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamServicePointRef" + current-data: + type: "array" + description: "Granularity period of the CurrentData identifies the specific\ + \ CurrentData instance in the scope of this OamJob.\r\n \ + \ For example, typically at least\r\n one 15min and\r\n\ + \ one 24hr;\r\n optionally one additional\ + \ configurable (< 15min)" + items: + $ref: "#/definitions/tapi.oam.CurrentData" description: "none" + tapi.oam.OamJobRef: + type: "object" + properties: + oam-job-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-job/tapi-oam:uuid" tapi.oam.OamProfile: allOf: - $ref: "#/definitions/tapi.common.GlobalClass" @@ -16295,11 +14023,6 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.oam.PmThresholdData" - pm-bin-data: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.PmBinData" description: "none" tapi.oam.OamProfileRef: type: "object" @@ -16312,37 +14035,26 @@ definitions: allOf: - $ref: "#/definitions/tapi.common.AdminStatePac" - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.oam.OamConstraint" - type: "object" properties: - oam-profile: + layer-protocol-name: description: "none" - $ref: "#/definitions/tapi.oam.OamProfileRef" - end-point: + $ref: "#/definitions/tapi.common.LayerProtocolName" + oam-service-point: type: "array" description: "none" items: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" + $ref: "#/definitions/tapi.oam.OamServicePoint" meg: description: "none" $ref: "#/definitions/tapi.oam.MegRef" description: "none" - tapi.oam.OamServiceEndPoint: + tapi.oam.OamServicePoint: allOf: - $ref: "#/definitions/tapi.common.AdminStatePac" - $ref: "#/definitions/tapi.common.LocalClass" - type: "object" properties: - peer-mep-identifier: - type: "array" - description: "This attribute models the MI_PeerMEP_ID[i] defined in G.8021\ - \ and configured as specified in G.8051. It provides the identifiers of\ - \ the MEPs which are peer to the subject MEP.\r\n This\ - \ attribute is not specified in case the OSEP relates to the provisioing\ - \ of an MIP.\r\n In case of P2P, there is only one\ - \ peer" - items: - type: "string" connectivity-service-end-point: description: "none" $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" @@ -16352,30 +14064,27 @@ definitions: service-interface-point: description: "none" $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + is-mip: + type: "boolean" + description: "If true, the object is related to a MIP.\r\n \ + \ If false, the object is related to a MEP." + default: false layer-protocol-name: description: "none" $ref: "#/definitions/tapi.common.LayerProtocolName" mep: description: "none" $ref: "#/definitions/tapi.oam.MepRef" - mep-identifier: - type: "string" - description: "This attribute contains the identifier of the MEP.\r\n \ - \ This attribute is empty in case the OSEP relates to\ - \ the provisioing of an MIP.\r\n " - direction: - description: "none" - $ref: "#/definitions/tapi.common.PortDirection" description: "none" - tapi.oam.OamServiceEndPointRef: + tapi.oam.OamServicePointRef: allOf: - $ref: "#/definitions/tapi.oam.OamServiceRef" - type: "object" properties: - oam-service-end-point-local-id: + oam-service-point-local-id: type: "string" description: "none" - x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-service/tapi-oam:end-point/tapi-oam:local-id" + x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-service/tapi-oam:oam-service-point/tapi-oam:local-id" description: "none" tapi.oam.OamServiceRef: type: "object" @@ -16384,55 +14093,49 @@ definitions: type: "string" description: "none" x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-service/tapi-oam:uuid" - tapi.oam.PmBinData: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - granularity-period: - description: "none" - $ref: "#/definitions/tapi.common.TimePeriod" - description: "none" - tapi.oam.PmCurrentData: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - elapsed-time: - description: "none" - $ref: "#/definitions/tapi.common.TimeInterval" - pm-history-data: - type: "array" - description: "in case of 24hr Current Data, at least 1 History Data.\r\n\ - \ In case of 15min Current Data, at least 16 History\ - \ Data.\r\n In case of <15min, the number of History\ - \ Data shall be able to cover a span of 4 hours." - items: - $ref: "#/definitions/tapi.oam.PmHistoryData" - granularity-period: - description: "none" - $ref: "#/definitions/tapi.common.TimePeriod" - suspect-interval-flag: - type: "boolean" - description: "This attribute is used to indicate that the performance data\ - \ for the current period may not be reliable. Some reasons for this to\ - \ occur are:\r\n Suspect data were detected by the\ - \ actual resource doing data collection.\r\n Transition\ - \ of the administrativeState attribute to/from the 'lock' state.\r\n \ - \ Transition of the operationalState to/from the 'disabled'\ - \ state.\r\n Scheduler setting that inhibits the\ - \ collection function.\r\n The performance counters\ - \ were reset during the interval.\r\n The currentData\ - \ (or subclass) object instance was created during the monitoring period." - default: false - timestamp: - type: "string" - description: "This attribute indicates the start of the current monitoring\ - \ interval.\r\n The value is bound to the quarter of\ - \ an hour in case of a 15 minute interval and bound to the hour in case\ - \ of a 24 hour interval." - description: "none" - tapi.oam.PmHistoryData: + tapi.oam.PerceivedSeverityType: + type: "string" + enum: + - "CRITICAL" + - "MAJOR" + - "MINOR" + - "WARNING" + - "CLEARED" + tapi.oam.PerceivedTcaSeverity: + type: "string" + enum: + - "WARNING" + - "CLEAR" + tapi.oam.PmDataPac: + type: "object" + properties: + suspect-interval-flag: + type: "boolean" + description: "This attribute is used to indicate that the performance data\ + \ for the current period may not be reliable. Some reasons for this to occur\ + \ are:\r\n Suspect data were detected by the actual resource\ + \ doing data collection.\r\n Transition of the administrativeState\ + \ attribute to/from the 'lock' state.\r\n Transition of\ + \ the operationalState to/from the 'disabled' state.\r\n \ + \ Scheduler setting that inhibits the collection function.\r\n \ + \ The performance counters were reset during the interval.\r\n\ + \ The currentData (or subclass) object instance was created\ + \ during the monitoring period." + default: false + granularity-period: + description: "none" + $ref: "#/definitions/tapi.common.TimePeriod" + tapi.oam.PmParameterValue: + type: "object" + properties: + pm-parameter-int-value: + type: "integer" + format: "int32" + description: "none" + pm-parameter-real-value: + type: "string" + description: "none" + tapi.oam.PmThresholdData: allOf: - $ref: "#/definitions/tapi.common.LocalClass" - type: "object" @@ -16440,151 +14143,368 @@ definitions: granularity-period: description: "none" $ref: "#/definitions/tapi.common.TimePeriod" - period-end-time: - type: "string" + threshold-parameter: + type: "array" description: "none" - suspect-interval-flag: - type: "boolean" - description: "This attribute indicates that the performance data may not\ - \ be reliable." - default: false - description: "none" - tapi.oam.PmThresholdData: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: + items: + $ref: "#/definitions/tapi.oam.ThresholdParameter" is-transient: type: "boolean" description: "none" default: false - granularity-period: - description: "none" - $ref: "#/definitions/tapi.common.TimePeriod" + applicable-job-type: + type: "array" + description: "This attribute allows an PMThresholdData instance to be constrained\ + \ to specific job types. If an PMThresholdData instance is so configured\ + \ to be applicable to more than one job type (worst case ALL), only the\ + \ parameters relevant for the job instance will be used (non-applicable\ + \ profile parameters will be ignored)" + items: + type: "string" description: "none" + tapi.oam.ServiceAffecting: + type: "string" + enum: + - "SERVICE_AFFECTING" + - "NOT_SERVICE_AFFECTING" + - "UNKNOWN" + tapi.oam.TcaInfo: + type: "object" + properties: + oam-job: + description: "MEF 35.1\r\n Identification of the PM Session\ + \ for which the TCA Function was configured." + $ref: "#/definitions/tapi.oam.OamJobRef" + threshold-parameter: + description: "none" + $ref: "#/definitions/tapi.oam.ThresholdParameter" + is-transient: + type: "boolean" + description: "none" + default: false + perceived-severity: + description: "none" + $ref: "#/definitions/tapi.oam.PerceivedTcaSeverity" + suspect-interval-flag: + type: "boolean" + description: "none" + default: false + measurement-interval: + type: "string" + description: "none" + tapi.oam.ThresholdCrossingQualifier: + type: "string" + enum: + - "NOT_APPLICABLE" + - "NEAR_END" + - "FAR_END" + - "BIDIRECTIONAL" + - "FORWARD" + - "BACKWARD" + tapi.oam.ThresholdParameter: + type: "object" + properties: + pm-parameter-below-thrs: + description: "none" + $ref: "#/definitions/tapi.oam.PmParameterValue" + pm-parameter-clear-thrs: + description: "none" + $ref: "#/definitions/tapi.oam.PmParameterValue" + pm-parameter-above-thrs: + description: "none" + $ref: "#/definitions/tapi.oam.PmParameterValue" + pm-parameter-name: + type: "string" + description: "none" + threshold-location: + description: "none" + $ref: "#/definitions/tapi.oam.ThresholdCrossingQualifier" tapi.oam.UpdateOamJob: type: "object" properties: output: $ref: "#/definitions/tapi.oam.updateoamjob.Output" + tapi.oam.UpdateOamProfile: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.updateoamprofile.Output" tapi.oam.UpdateOamService: type: "object" properties: output: $ref: "#/definitions/tapi.oam.updateoamservice.Output" - tapi.oam.UpdateOamServiceEndPoint: + tapi.oam.UpdateOamServicePoint: type: "object" properties: output: - $ref: "#/definitions/tapi.oam.updateoamserviceendpoint.Output" + $ref: "#/definitions/tapi.oam.updateoamservicepoint.Output" tapi.oam.createoamjob.Input: type: "object" properties: schedule: - type: "string" description: "none" - oam-service-end-point: + $ref: "#/definitions/tapi.common.TimeRange" + name: type: "array" - description: "none" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." items: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" + $ref: "#/definitions/tapi.common.NameAndValue" + oam-service-point-id: + type: "string" + description: "UUID of the associated OSEPs: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" oam-job-type: type: "string" description: "none" - oam-profile: - description: "none" - $ref: "#/definitions/tapi.oam.OamProfile" state: - type: "string" description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + oam-profile-id: + type: "string" + description: "UUID of the OamProfile to be applied: An identifier that is\ + \ universally unique within an identifier space, where the identifier space\ + \ is itself globally unique, and immutable.\r\n An UUID\ + \ carries no semantics with respect to the purpose or state of the entity.\r\ + \n UUID here uses string representation as defined in\ + \ RFC 4122. The canonical representation uses lowercase characters.\r\n\ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + oam-service-id: + type: "string" + description: "UUID of the associated OamService: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.oam.createoamjob.Output: type: "object" properties: oam-job: description: "none" $ref: "#/definitions/tapi.oam.OamJob" - tapi.oam.createoamservice.Input: + tapi.oam.createoamprofile.Input: type: "object" properties: - oam-constraint: - description: "none" - $ref: "#/definitions/tapi.oam.OamConstraint" - state: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: type: "string" - description: "none" - end-point: + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + pm-threshold-data: type: "array" description: "none" items: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - tapi.oam.createoamservice.Output: + $ref: "#/definitions/tapi.oam.PmThresholdData" + tapi.oam.createoamprofile.Output: type: "object" properties: - service: + oam-profile: description: "none" - $ref: "#/definitions/tapi.oam.OamService" - tapi.oam.createoamserviceendpoint.Input: + $ref: "#/definitions/tapi.oam.OamProfile" + tapi.oam.createoamservice.Input: type: "object" properties: - peer-mep-identifier: - type: "array" + layer-protocol-name: description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." items: - type: "string" - service-id: - type: "string" + $ref: "#/definitions/tapi.common.NameAndValue" + oam-service-point: + type: "array" description: "none" - sip-id: - type: "string" + items: + $ref: "#/definitions/tapi.oam.OamServicePoint" + state: description: "none" - c-sep-id: + $ref: "#/definitions/tapi.common.AdministrativeState" + uuid: type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.createoamservice.Output: + type: "object" + properties: + oam-service: description: "none" - mep-identifier: - type: "string" + $ref: "#/definitions/tapi.oam.OamService" + tapi.oam.createoamservicepoint.Input: + type: "object" + properties: + layer-protocol-name: description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" state: - type: "string" - description: "none" - layer: - type: "string" description: "none" - direction: + $ref: "#/definitions/tapi.common.AdministrativeState" + connectivity-service-end-point-id: + type: "string" + description: "UUID of the CSEP to be monitored: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + service-interface-point-id: + type: "string" + description: "UUID of the associated SIP to be monitored: An identifier that\ + \ is universally unique within an identifier space, where the identifier\ + \ space is itself globally unique, and immutable.\r\n \ + \ An UUID carries no semantics with respect to the purpose or state of\ + \ the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + oam-service-id: + type: "string" + description: "UUID of the parent OamService: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + uuid: type: "string" - description: "none" - tapi.oam.createoamserviceendpoint.Output: + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.createoamservicepoint.Output: type: "object" properties: - end-point: + oam-service-point: description: "none" - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" + $ref: "#/definitions/tapi.oam.OamServicePoint" tapi.oam.deleteoamjob.Input: type: "object" properties: - job-id: + uuid: type: "string" - description: "none" - tapi.oam.deleteoamservice.Input: + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.deleteoamprofile.Input: type: "object" properties: - service-id: + uuid: type: "string" - description: "none" - tapi.oam.deleteoamserviceendpoint.Input: + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.deleteoamservice.Input: type: "object" properties: - service-id: + uuid: type: "string" - description: "none" - o-sep-id: + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.deleteoamservicepoint.Input: + type: "object" + properties: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.oam.getmeg.Input: type: "object" properties: - service-id: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.oam.getmeg.Output: type: "object" properties: @@ -16594,118 +14514,246 @@ definitions: tapi.oam.getoamjob.Input: type: "object" properties: - job-id: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.oam.getoamjob.Output: type: "object" properties: oam-job: description: "none" $ref: "#/definitions/tapi.oam.OamJob" - tapi.oam.getoamservice.Input: + tapi.oam.getoamjoblist.Output: type: "object" properties: - service-id: - type: "string" + oam-job: + type: "array" description: "none" - tapi.oam.getoamservice.Output: + items: + $ref: "#/definitions/tapi.oam.OamJob" + tapi.oam.getoamprofile.Input: type: "object" properties: - service: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.getoamprofile.Output: + type: "object" + properties: + oam-profile: description: "none" - $ref: "#/definitions/tapi.oam.OamService" - tapi.oam.getoamserviceendpoint.Input: + $ref: "#/definitions/tapi.oam.OamProfile" + tapi.oam.getoamprofilelist.Output: type: "object" properties: - service-id: - type: "string" + oam-profile: + type: "array" description: "none" - o-sep-id: + items: + $ref: "#/definitions/tapi.oam.OamProfile" + tapi.oam.getoamservice.Input: + type: "object" + properties: + uuid: type: "string" - description: "none" - tapi.oam.getoamserviceendpoint.Output: + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.getoamservice.Output: type: "object" properties: - end-point: + oam-service: description: "none" - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" + $ref: "#/definitions/tapi.oam.OamService" tapi.oam.getoamservicelist.Output: type: "object" properties: - service: + oam-service: type: "array" description: "none" - items: - $ref: "#/definitions/tapi.oam.OamService" + items: + $ref: "#/definitions/tapi.oam.OamService" + tapi.oam.getoamservicepoint.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.getoamservicepoint.Output: + type: "object" + properties: + oam-service-point: + description: "none" + $ref: "#/definitions/tapi.oam.OamServicePoint" tapi.oam.updateoamjob.Input: type: "object" properties: - job-id: - type: "string" - description: "none" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" schedule: - type: "string" - description: "none" - oam-profile: description: "none" - $ref: "#/definitions/tapi.oam.OamProfile" + $ref: "#/definitions/tapi.common.TimeRange" state: - type: "string" description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + oam-profile-id: + type: "string" + description: "UUID of the OamProfile to be applied: An identifier that is\ + \ universally unique within an identifier space, where the identifier space\ + \ is itself globally unique, and immutable.\r\n An UUID\ + \ carries no semantics with respect to the purpose or state of the entity.\r\ + \n UUID here uses string representation as defined in\ + \ RFC 4122. The canonical representation uses lowercase characters.\r\n\ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.oam.updateoamjob.Output: type: "object" properties: oam-job: description: "none" $ref: "#/definitions/tapi.oam.OamJob" - tapi.oam.updateoamservice.Input: + tapi.oam.updateoamprofile.Input: type: "object" properties: - oam-constraint: - description: "none" - $ref: "#/definitions/tapi.oam.OamConstraint" - service-id: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + pm-threshold-data: + type: "array" description: "none" - state: - type: "string" + items: + $ref: "#/definitions/tapi.oam.PmThresholdData" + tapi.oam.updateoamprofile.Output: + type: "object" + properties: + oam-profile: description: "none" - end-point: + $ref: "#/definitions/tapi.oam.OamProfile" + tapi.oam.updateoamservice.Input: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + oam-service-point: type: "array" description: "none" items: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" + $ref: "#/definitions/tapi.oam.OamServicePoint" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.oam.updateoamservice.Output: type: "object" properties: - service: + oam-service: description: "none" $ref: "#/definitions/tapi.oam.OamService" - tapi.oam.updateoamserviceendpoint.Input: + tapi.oam.updateoamservicepoint.Input: type: "object" properties: - service-id: - type: "string" - description: "none" - o-sep-id: - type: "string" - description: "none" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" state: - type: "string" description: "none" - tapi.oam.updateoamserviceendpoint.Output: + $ref: "#/definitions/tapi.common.AdministrativeState" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.updateoamservicepoint.Output: type: "object" properties: - end-point: + oam-service-point: description: "none" - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" + $ref: "#/definitions/tapi.oam.OamServicePoint" tapi.path.computation.ComputeP2PPath: type: "object" properties: output: $ref: "#/definitions/tapi.path.computation.computep2ppath.Output" - tapi.path.computation.ContextAugmentation3: + tapi.path.computation.ContextAugmentation2: type: "object" properties: path-computation-context: @@ -16774,8 +14822,10 @@ definitions: - type: "object" properties: topology-constraint: + type: "array" description: "none" - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" path: type: "array" description: "none" @@ -16789,12 +14839,18 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" routing-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.RoutingConstraint" optimization-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" + direction: + description: "none" + $ref: "#/definitions/tapi.common.ForwardingDirection" description: "none" tapi.path.computation.PathObjectiveFunction: allOf: @@ -16859,16 +14915,16 @@ definitions: description: "none" $ref: "#/definitions/tapi.common.Capacity" description: "The association of the FC to LTPs is made via EndPoints.\r\n \ - \ The EndPoint (EP) object class models the access to the FC\ - \ function. \r\n The traffic forwarding between the associated\ - \ EPs of the FC depends upon the type of FC and may be associated with FcSwitch\ - \ object instances. \r\n In cases where there is resilience\ - \ the EndPoint may convey the resilience role of the access to the FC. \r\n\ - \ It can represent a protected (resilient/reliable) point or\ - \ a protecting (unreliable working or protection) point.\r\n \ - \ The EP replaces the Protection Unit of a traditional protection model.\ - \ \r\n The ForwadingConstruct can be considered as a component\ - \ and the EndPoint as a Port on that component" + \ The EndPoint (EP) object class models the access to the FC function.\ + \ \r\n The traffic forwarding between the associated EPs of the\ + \ FC depends upon the type of FC and may be associated with FcSwitch object\ + \ instances. \r\n In cases where there is resilience the EndPoint\ + \ may convey the resilience role of the access to the FC. \r\n \ + \ It can represent a protected (resilient/reliable) point or a protecting\ + \ (unreliable working or protection) point.\r\n The EP replaces\ + \ the Protection Unit of a traditional protection model. \r\n The\ + \ ForwadingConstruct can be considered as a component and the EndPoint as\ + \ a Port on that component" tapi.path.computation.RouteObjectiveFunction: type: "string" enum: @@ -16886,6 +14942,9 @@ definitions: type: "boolean" description: "To distinguish if the resources are to be exclusive to the service" default: true + tolerable-impact: + type: "string" + description: "Grades of maximum tolerable disruption to traffic." diversity-policy: description: "none" $ref: "#/definitions/tapi.path.computation.DiversityPolicy" @@ -16909,78 +14968,100 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.topology.RiskCharacteristic" - route-direction: - description: "none" - $ref: "#/definitions/tapi.common.ForwardingDirection" tapi.path.computation.TopologyConstraint: - type: "object" - properties: - include-node: - type: "array" - description: "This is a loose constraint - that is it is unordered and could\ - \ be a partial list" - items: - $ref: "#/definitions/tapi.topology.NodeRef" - exclude-link: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.LinkRef" - avoid-topology: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.TopologyRef" - exclude-path: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.path.computation.PathRef" - include-link: - type: "array" - description: "This is a loose constraint - that is it is unordered and could\ - \ be a partial list " - items: - $ref: "#/definitions/tapi.topology.LinkRef" - preferred-transport-layer: - type: "array" - description: "soft constraint requested by client to indicate the layer(s)\ - \ of transport connection that it prefers to carry the service. This could\ - \ be same as the service layer or one of the supported server layers" - items: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + include-node: + type: "string" + description: "This is a loose constraint - that is it is unordered and could\ + \ be a partial list" + exclude-link: + type: "string" + description: "none" + avoid-topology: + type: "string" + description: "none" + exclude-path: + type: "string" + description: "none" + include-topology: + type: "string" + description: "none" + include-path: + type: "string" + description: "none" + exclude-node-edge-point: + type: "string" + description: "none" + include-node-edge-point: + type: "string" + description: "none" + include-link: + type: "string" + description: "This is a loose constraint - that is it is unordered and could\ + \ be a partial list " + preferred-transport-layer: + description: "soft constraint requested by client to indicate the layer(s)\ + \ of transport connection that it prefers to carry the service. This could\ + \ be same as the service layer or one of the supported server layers" $ref: "#/definitions/tapi.common.LayerProtocolName" - exclude-node: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.NodeRef" - include-topology: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.TopologyRef" - include-path: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.path.computation.PathRef" + exclude-node: + type: "string" + description: "none" + constraint-weight: + type: "integer" + format: "int32" + description: "Zero and positive values: zero means 'strongly required to\ + \ be included', +1 means 'less strongly required to be included', etc.\r\ + \n For example the work/intended route will be calculated\ + \ considering the topologies which weights are lowest (but not negative).\r\ + \n Negative values: -1 means 'strongly required to be excluded',\ + \ -2 means 'less strongly required to be excluded', etc." + description: "The TopologyConstraint allows to specify topology entities in\ + \ order to impose specific constraints (as denoted by the attribute name)\ + \ on Connectivity/Path.\r\n The topology entities are specified\ + \ by their instance uuid rather than using references/path (to allow for mapping\ + \ to Yang 1.0).\r\n This loose typing and reference necessitates\ + \ that implementations validate not only the presence of the instance, but\ + \ also that it is of the correct type as implied by the attribute name.\r\n\ + \ If this validation fails, then the implementation is expceted\ + \ to return an error.\r\n " tapi.path.computation.computep2ppath.Input: type: "object" properties: topology-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - routing-constraint: + end-point: + type: "array" description: "none" - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + items: + $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" objective-function: description: "none" $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" - sep: + name: type: "array" - description: "none" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." items: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + $ref: "#/definitions/tapi.common.NameAndValue" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.path.computation.computep2ppath.Output: type: "object" properties: @@ -16990,9 +15071,16 @@ definitions: tapi.path.computation.deletep2ppath.Input: type: "object" properties: - path-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.path.computation.deletep2ppath.Output: type: "object" properties: @@ -17002,15 +15090,29 @@ definitions: tapi.path.computation.optimizep2ppath.Input: type: "object" properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" routing-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - path-id-or-name: - type: "string" - description: "none" optimization-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" objective-function: description: "none" $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" @@ -17106,7 +15208,7 @@ definitions: type: "string" description: "High frequency deviation from true periodicity of a signal and\ \ therefore a small high rate of change of transfer latency.\r\n \ - \ Applies to TDM systems (and not packet)." + \ Applies to TDM systems (and not packet)." fixed-latency-characteristic: type: "string" description: "A TopologicalEntity suffers delay caused by the realization\ @@ -17117,7 +15219,7 @@ definitions: type: "string" description: "Low frequency deviation from true periodicity of a signal and\ \ therefore a small low rate of change of transfer latency.\r\n \ - \ Applies to TDM systems (and not packet)." + \ Applies to TDM systems (and not packet)." queing-latency-characteristic: type: "string" description: "The specific queuing latency for the traffic property." @@ -17149,19 +15251,22 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.common.LayerProtocolName" - resilience-type: + restoration-policy: description: "none" - $ref: "#/definitions/tapi.topology.ResilienceType" + $ref: "#/definitions/tapi.topology.RestorationPolicy" node-edge-point: type: "array" description: "none" items: $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + protection-type: + description: "none" + $ref: "#/definitions/tapi.topology.ProtectionType" direction: - description: "The directionality of the Link. \r\n Is\ - \ applicable to simple Links where all LinkEnds are BIDIRECTIONAL (the\ - \ Link will be BIDIRECTIONAL) or UNIDIRECTIONAL (the Link will be UNIDIRECTIONAL).\ - \ \r\n Is not present in more complex cases." + description: "The directionality of the Link. \r\n Is applicable\ + \ to simple Links where all LinkEnds are BIDIRECTIONAL (the Link will\ + \ be BIDIRECTIONAL) or UNIDIRECTIONAL (the Link will be UNIDIRECTIONAL).\ + \ \r\n Is not present in more complex cases." $ref: "#/definitions/tapi.common.ForwardingDirection" description: "The Link object class models effective adjacency between two or\ \ more ForwardingDomains (FD). " @@ -17175,6 +15280,16 @@ definitions: description: "none" x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:link/tapi-topology:uuid" description: "none" + tapi.topology.NepLayerProtocolCapability: + type: "object" + properties: + layer-protocol-qualifier: + type: "string" + description: "none" + number-of-cep-instances: + type: "integer" + format: "int32" + description: "none" tapi.topology.NetworkTopologyService: allOf: - $ref: "#/definitions/tapi.common.GlobalClass" @@ -17204,16 +15319,16 @@ definitions: encap-topology: description: "none" $ref: "#/definitions/tapi.topology.TopologyRef" - owned-node-edge-point: + node-rule-group: type: "array" description: "none" items: - $ref: "#/definitions/tapi.topology.NodeEdgePoint" - node-rule-group: + $ref: "#/definitions/tapi.topology.NodeRuleGroup" + node-edge-point: type: "array" description: "none" items: - $ref: "#/definitions/tapi.topology.NodeRuleGroup" + $ref: "#/definitions/tapi.topology.NodeEdgePoint" aggregated-node-edge-point: type: "array" description: "none" @@ -17222,8 +15337,8 @@ definitions: description: "The ForwardingDomain (FD) object class models the ForwardingDomain\ \ topological component which is used to effect forwarding of transport characteristic\ \ information and offers the potential to enable forwarding. \r\n \ - \ At the lowest level of recursion, an FD (within a network element\ - \ (NE)) represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ + \ At the lowest level of recursion, an FD (within a network element (NE))\ + \ represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ \ multiple switch matrices (FDs). " tapi.topology.NodeEdgePoint: allOf: @@ -17245,6 +15360,11 @@ definitions: \ balancing/Resilience) should be considered experimental" items: $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + available-cep-layer-protocol: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NepLayerProtocolCapability" aggregated-node-edge-point: type: "array" description: "none" @@ -17256,14 +15376,9 @@ definitions: link-port-direction: description: "The orientation of defined flow at the LinkEnd." $ref: "#/definitions/tapi.common.PortDirection" - supported-cep-layer-protocol-qualifier: - type: "array" - description: "none" - items: - type: "string" description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ \ termination and adaptation functions of one or more transport layers. \r\ - \n The structure of LTP supports all transport protocols including\ + \n The structure of LTP supports all transport protocols including\ \ circuit and packet forms." tapi.topology.NodeEdgePointRef: allOf: @@ -17273,7 +15388,7 @@ definitions: node-edge-point-uuid: type: "string" description: "none" - x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:owned-node-edge-point/tapi-topology:uuid" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:node-edge-point/tapi-topology:uuid" description: "none" tapi.topology.NodeRef: allOf: @@ -17328,41 +15443,32 @@ definitions: tapi.topology.ProtectionType: type: "string" enum: - - "NO_PROTECTON" + - "NO_PROTECTION" - "ONE_PLUS_ONE_PROTECTION" - - "ONE_PLUS_ONE_PROTECTION_WITH_DYNAMIC_RESTORATION" - - "PERMANENT_ONE_PLUS_ONE_PROTECTION" - "ONE_FOR_ONE_PROTECTION" - - "DYNAMIC_RESTORATION" - - "PRE_COMPUTED_RESTORATION" - tapi.topology.ResilienceType: - type: "object" - properties: - restoration-policy: - description: "none" - $ref: "#/definitions/tapi.topology.RestorationPolicy" - protection-type: - description: "none" - $ref: "#/definitions/tapi.topology.ProtectionType" + - "ONE_FOR_N_PROTECTION" + - "M_FOR_N_PROTECTION" + - "ONE_FOR_ONE_BY_N" tapi.topology.RestorationPolicy: type: "string" enum: - "PER_DOMAIN_RESTORATION" - "END_TO_END_RESTORATION" - "NA" + - "DYNAMIC_RESTORATION" + - "PRE_COMPUTED_RESTORATION" tapi.topology.RiskCharacteristic: type: "object" properties: risk-characteristic-name: type: "string" description: "The name of the risk characteristic. The characteristic may\ - \ be related to a specific degree of closeness. \r\n \ - \ For example a particular characteristic may apply to failures that are\ - \ localized (e.g. to one side of a road) where as another characteristic\ - \ may relate to failures that have a broader impact (e.g. both sides of\ - \ a road that crosses a bridge).\r\n Depending upon the\ - \ importance of the traffic being routed different risk characteristics\ - \ will be evaluated." + \ be related to a specific degree of closeness. \r\n For\ + \ example a particular characteristic may apply to failures that are localized\ + \ (e.g. to one side of a road) where as another characteristic may relate\ + \ to failures that have a broader impact (e.g. both sides of a road that\ + \ crosses a bridge).\r\n Depending upon the importance of\ + \ the traffic being routed different risk characteristics will be evaluated." risk-identifier-list: type: "array" description: "A list of the identifiers of each physical/geographic unit (with\ @@ -17424,11 +15530,16 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.topology.Node" + boundary-node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" description: "The ForwardingDomain (FD) object class models the ForwardingDomain\ \ topological component which is used to effect forwarding of transport characteristic\ \ information and offers the potential to enable forwarding. \r\n \ - \ At the lowest level of recursion, an FD (within a network element\ - \ (NE)) represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ + \ At the lowest level of recursion, an FD (within a network element (NE))\ + \ represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ \ multiple switch matrices (FDs). " tapi.topology.TopologyContext: type: "object" @@ -17463,7 +15574,7 @@ definitions: error-characteristic: type: "string" description: "Describes the degree to which the signal propagated can be errored.\ - \ \r\n Applies to TDM systems as the errored signal will\ + \ \r\n Applies to TDM systems as the errored signal will\ \ be propagated and not packet as errored packets will be discarded." unavailable-time-characteristic: type: "string" @@ -17476,19 +15587,19 @@ definitions: delivery-order-characteristic: type: "string" description: "Describes the degree to which packets will be delivered out\ - \ of sequence.\r\n Does not apply to TDM as the TDM protocols\ + \ of sequence.\r\n Does not apply to TDM as the TDM protocols\ \ maintain strict order." repeat-delivery-characteristic: type: "string" description: "Primarily applies to packet systems where a packet may be delivered\ - \ more than once (in fault recovery for example). \r\n \ - \ It can also apply to TDM where several frames may be received twice\ - \ due to switching in a system with a large differential propagation delay." + \ more than once (in fault recovery for example). \r\n It\ + \ can also apply to TDM where several frames may be received twice due to\ + \ switching in a system with a large differential propagation delay." loss-characteristic: type: "string" description: "Describes the acceptable characteristic of lost packets where\ \ loss may result from discard due to errors or overflow.\r\n \ - \ Applies to packet systems and not TDM (as for TDM errored signals\ + \ Applies to packet systems and not TDM (as for TDM errored signals\ \ are propagated unless grossly errored and overflow/underflow turns into\ \ timing slips)." tapi.topology.TransferTimingPac: @@ -17525,12 +15636,27 @@ definitions: tapi.topology.getlinkdetails.Input: type: "object" properties: - link-id-or-name: + link-id: type: "string" - description: "none" - topology-id-or-name: - type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.topology.getlinkdetails.Output: type: "object" properties: @@ -17540,12 +15666,27 @@ definitions: tapi.topology.getnodedetails.Input: type: "object" properties: - node-id-or-name: - type: "string" - description: "none" - topology-id-or-name: - type: "string" - description: "none" + node-id: + type: "string" + description: "UUID of the Node: An identifier that is universally unique within\ + \ an identifier space, where the identifier space is itself globally unique,\ + \ and immutable.\r\n An UUID carries no semantics with\ + \ respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC 4122. The canonical\ + \ representation uses lowercase characters.\r\n Pattern:\ + \ [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\ + \ \r\n Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.topology.getnodedetails.Output: type: "object" properties: @@ -17555,15 +15696,37 @@ definitions: tapi.topology.getnodeedgepointdetails.Input: type: "object" properties: - ep-id-or-name: - type: "string" - description: "none" - node-id-or-name: - type: "string" - description: "none" - topology-id-or-name: + node-id: + type: "string" + description: "UUID of the parent Node: An identifier that is universally unique\ + \ within an identifier space, where the identifier space is itself globally\ + \ unique, and immutable.\r\n An UUID carries no semantics\ + \ with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC 4122. The\ + \ canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\ + \ \r\n Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Node's Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + node-edge-point-id: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.topology.getnodeedgepointdetails.Output: type: "object" properties: @@ -17573,9 +15736,16 @@ definitions: tapi.topology.gettopologydetails.Input: type: "object" properties: - topology-id-or-name: + topology-id: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.topology.gettopologydetails.Output: type: "object" properties: @@ -17590,9 +15760,9 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.topology.Topology" - tapi.topology.node.OwnedNodeEdgePoint: + tapi.topology.node.NodeEdgePoint: allOf: - - $ref: "#/definitions/tapi.connectivity.OwnedNodeEdgePointAugmentation1" + - $ref: "#/definitions/tapi.connectivity.NodeEdgePointAugmentation1" - $ref: "#/definitions/tapi.topology.NodeEdgePoint" tapi.topology.topology.Node: allOf: @@ -17612,16 +15782,16 @@ definitions: encap-topology: description: "none" $ref: "#/definitions/tapi.topology.TopologyRef" - owned-node-edge-point: + node-rule-group: type: "array" description: "none" items: - $ref: "#/definitions/tapi.topology.node.OwnedNodeEdgePoint" - node-rule-group: + $ref: "#/definitions/tapi.topology.NodeRuleGroup" + node-edge-point: type: "array" description: "none" items: - $ref: "#/definitions/tapi.topology.NodeRuleGroup" + $ref: "#/definitions/tapi.topology.node.NodeEdgePoint" aggregated-node-edge-point: type: "array" description: "none" diff --git a/OAS/tapi-odu@2018-12-10.yaml b/OAS/tapi-odu@2019-03-31.yaml similarity index 67% rename from OAS/tapi-odu@2018-12-10.yaml rename to OAS/tapi-odu@2019-03-31.yaml index d6835120..590fb2a6 100644 --- a/OAS/tapi-odu@2018-12-10.yaml +++ b/OAS/tapi-odu@2019-03-31.yaml @@ -1,10 +1,137 @@ --- swagger: "2.0" info: - description: "tapi-oam,tapi-path-computation,tapi-connectivity,tapi-dsr,tapi-notification,tapi-topology,tapi-common,tapi-odu\ - \ API generated from yang definitions" - version: "1.0" - title: "tapi-oam,tapi-path-computation,tapi-connectivity,tapi-dsr,tapi-notification,tapi-topology,tapi-common,tapi-odu\ + description: "\r\n This module contains TAPI Odu Model definitions.\r\n \ + \ Source: TapiOdu.uml\r\n Copyright (c) 2018 Open Networking Foundation\ + \ (ONF). All rights reserved.\r\n License: This module is distributed under\ + \ the Apache License 2.0\r\n - The TAPI YANG models included in this TAPI\ + \ release are a *normative* part of the TAPI SDK.\r\n - The YANG specifications\ + \ have been generated from the corresponding UML model using the [ONF EAGLE UML2YANG\ + \ mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Notification\ + \ Model definitions.\r\n Source: TapiNotification.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Topology\ + \ Model definitions.\r\n Source: TapiTopology.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI DSR Model\ + \ definitions.\r\n Source: TapiDsr.uml\r\n Copyright (c) 2018 Open\ + \ Networking Foundation (ONF). All rights reserved.\r\n License: This module\ + \ is distributed under the Apache License 2.0\r\n - The TAPI YANG models\ + \ included in this TAPI release are a *normative* part of the TAPI SDK.\r\n \ + \ - The YANG specifications have been generated from the corresponding UML\ + \ model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Common Model\ + \ definitions.\r\n Source: TapiCommon.uml\r\n Copyright (c) 2018\ + \ Open Networking Foundation (ONF). All rights reserved.\r\n License: This\ + \ module is distributed under the Apache License 2.0\r\n - The TAPI YANG\ + \ models included in this TAPI release are a *normative* part of the TAPI SDK.\r\ + \n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Path Computation\ + \ Model definitions.\r\n Source: TapiPathComputation.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Connectivity\ + \ Model definitions.\r\n Source: TapiConnectivity.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI OAM Model\ + \ definitions.\r\n Source: TapiOam.uml\r\n Copyright (c) 2018 Open\ + \ Networking Foundation (ONF). All rights reserved.\r\n License: This module\ + \ is distributed under the Apache License 2.0\r\n - The TAPI YANG models\ + \ included in this TAPI release are a *normative* part of the TAPI SDK.\r\n \ + \ - The YANG specifications have been generated from the corresponding UML\ + \ model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases." + version: "2.2.0" + title: "tapi-odu,tapi-notification,tapi-topology,tapi-dsr,tapi-common,tapi-path-computation,tapi-connectivity,tapi-oam\ \ API" host: "localhost:1234" consumes: @@ -16,7 +143,8 @@ paths: get: tags: - "tapi-common" - description: "returns tapi.common.Context" + summary: "returns tapi.common.Context" + description: "none" parameters: [] responses: 200: @@ -28,7 +156,8 @@ paths: post: tags: - "tapi-common" - description: "creates tapi.common.Context" + summary: "creates tapi.common.Context" + description: "none" parameters: - in: "body" name: "tapi.common.Context.body-param" @@ -46,7 +175,8 @@ paths: put: tags: - "tapi-common" - description: "creates or updates tapi.common.Context" + summary: "creates or updates tapi.common.Context" + description: "none" parameters: - in: "body" name: "tapi.common.Context.body-param" @@ -64,7 +194,8 @@ paths: delete: tags: - "tapi-common" - description: "removes tapi.common.Context" + summary: "removes tapi.common.Context" + description: "none" parameters: [] responses: 400: @@ -75,7 +206,8 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityContext" + summary: "returns tapi.connectivity.context.ConnectivityContext" + description: "Augments the base TAPI Context with ConnectivityService information" parameters: [] responses: 200: @@ -87,10 +219,11 @@ paths: post: tags: - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityContext" + summary: "creates tapi.connectivity.context.ConnectivityContext" + description: "Augments the base TAPI Context with ConnectivityService information" parameters: - in: "body" - name: "tapi.connectivity.ConnectivityContext.body-param" + name: "tapi.connectivity.context.ConnectivityContext.body-param" description: "tapi.connectivity.ConnectivityContext to be added to list" required: false schema: @@ -105,10 +238,11 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityContext" + summary: "creates or updates tapi.connectivity.context.ConnectivityContext" + description: "Augments the base TAPI Context with ConnectivityService information" parameters: - in: "body" - name: "tapi.connectivity.ConnectivityContext.body-param" + name: "tapi.connectivity.context.ConnectivityContext.body-param" description: "tapi.connectivity.ConnectivityContext to be added or updated" required: false schema: @@ -123,7 +257,8 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityContext" + summary: "removes tapi.connectivity.context.ConnectivityContext" + description: "Augments the base TAPI Context with ConnectivityService information" parameters: [] responses: 400: @@ -134,7 +269,8 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.Connection" + summary: "returns tapi.connectivity.Connection" + description: "none" parameters: - name: "uuid" in: "path" @@ -148,11 +284,31 @@ paths: $ref: "#/definitions/tapi.connectivity.Connection" 400: description: "Internal error" + /data/context/connectivity-context/connection={uuid}/bounding-node/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.topology.NodeRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connection" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeRef" + schema: + $ref: "#/definitions/tapi.topology.NodeRef" + 400: + description: "Internal error" ? /data/context/connectivity-context/connection={uuid}/connection-end-point={topology-uuid},{node-uuid},{node-edge-point-uuid},{connection-end-point-uuid}/ : get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionEndPointRef" + summary: "returns tapi.connectivity.ConnectionEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -190,7 +346,14 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionRef" + summary: "returns tapi.connectivity.ConnectionRef" + description: "An Connection object supports a recursive aggregation relationship\ + \ such that the internal construction of an Connection can be exposed as multiple\ + \ lower level Connection objects (partitioning).\r\n Aggregation\ + \ is used as for the Node/Topology to allow changes in hierarchy. \r\n \ + \ Connection aggregation reflects Node/Topology aggregation.\ + \ \r\n The FC represents a Cross-Connection in an NE. The Cross-Connection\ + \ in an NE is not necessarily the lowest level of FC partitioning." parameters: - name: "uuid" in: "path" @@ -213,7 +376,10 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -236,7 +402,8 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.Route" + summary: "returns tapi.connectivity.Route" + description: "none" parameters: - name: "uuid" in: "path" @@ -259,7 +426,8 @@ paths: : get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionEndPointRef" + summary: "returns tapi.connectivity.ConnectionEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -302,7 +470,10 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -330,7 +501,8 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.topology.LinkRef" + summary: "returns tapi.topology.LinkRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -358,7 +530,8 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.SwitchControl" + summary: "returns tapi.connectivity.SwitchControl" + description: "none" parameters: - name: "uuid" in: "path" @@ -381,7 +554,10 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -405,34 +581,12 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/resilience-type/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.ResilienceType" - parameters: - - name: "uuid" - in: "path" - description: "Id of connection" - required: true - type: "string" - - name: "switch-control-uuid" - in: "path" - description: "Id of switch-control" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.ResilienceType" - schema: - $ref: "#/definitions/tapi.topology.ResilienceType" - 400: - description: "Internal error" ? /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/sub-switch-control={connection-uuid},{sub-switch-control-switch-control-uuid}/ : get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.SwitchControlRef" + summary: "returns tapi.connectivity.SwitchControlRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -465,7 +619,8 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.Switch" + summary: "returns tapi.connectivity.Switch" + description: "none" parameters: - name: "uuid" in: "path" @@ -493,7 +648,10 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -526,7 +684,8 @@ paths: : get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionEndPointRef" + summary: "returns tapi.connectivity.ConnectionEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -574,7 +733,8 @@ paths: : get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.RouteRef" + summary: "returns tapi.connectivity.RouteRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -612,14 +772,16 @@ paths: post: tags: - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityService" + summary: "creates tapi.connectivity.connectivitycontext.ConnectivityService" + description: "none" parameters: - in: "body" - name: "tapi.connectivity.ConnectivityService.body-param" - description: "tapi.connectivity.ConnectivityService to be added to list" + name: "tapi.connectivity.connectivitycontext.ConnectivityService.body-param" + description: "tapi.connectivity.connectivitycontext.ConnectivityService to\ + \ be added to list" required: false schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityService" + $ref: "#/definitions/tapi.connectivity.connectivitycontext.ConnectivityService" responses: 201: description: "Object created" @@ -631,7 +793,8 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityService" + summary: "returns tapi.connectivity.connectivitycontext.ConnectivityService" + description: "none" parameters: - name: "uuid" in: "path" @@ -640,38 +803,16 @@ paths: type: "string" responses: 200: - description: "tapi.connectivity.ConnectivityService" + description: "tapi.connectivity.connectivitycontext.ConnectivityService" schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityService" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityService" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.connectivity.ConnectivityService.body-param" - description: "tapi.connectivity.ConnectivityService to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityService" - responses: - 201: - description: "Object created" + $ref: "#/definitions/tapi.connectivity.connectivitycontext.ConnectivityService" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityService" + summary: "creates or updates tapi.connectivity.connectivitycontext.ConnectivityService" + description: "none" parameters: - name: "uuid" in: "path" @@ -679,11 +820,12 @@ paths: required: true type: "string" - in: "body" - name: "tapi.connectivity.ConnectivityService.body-param" - description: "tapi.connectivity.ConnectivityService to be added or updated" + name: "tapi.connectivity.connectivitycontext.ConnectivityService.body-param" + description: "tapi.connectivity.connectivitycontext.ConnectivityService to\ + \ be added or updated" required: false schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityService" + $ref: "#/definitions/tapi.connectivity.connectivitycontext.ConnectivityService" responses: 201: description: "Object created" @@ -694,7 +836,8 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityService" + summary: "removes tapi.connectivity.connectivitycontext.ConnectivityService" + description: "none" parameters: - name: "uuid" in: "path" @@ -706,34 +849,12 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/avoid-topology={topology-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of avoid-topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" /data/context/connectivity-context/connectivity-service={uuid}/connection={connection-uuid}/: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionRef" + summary: "returns tapi.connectivity.ConnectionRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -752,11 +873,12 @@ paths: $ref: "#/definitions/tapi.connectivity.ConnectionRef" 400: description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/coroute-inclusion/: + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityServiceRef" + summary: "returns tapi.connectivity.ConnectivityConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -765,15 +887,16 @@ paths: type: "string" responses: 200: - description: "tapi.connectivity.ConnectivityServiceRef" + description: "tapi.connectivity.ConnectivityConstraint" schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" 400: description: "Internal error" post: tags: - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceRef" + summary: "creates tapi.connectivity.ConnectivityConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -781,11 +904,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.connectivity.ConnectivityServiceRef.body-param" - description: "tapi.connectivity.ConnectivityServiceRef to be added to list" + name: "tapi.connectivity.ConnectivityConstraint.body-param" + description: "tapi.connectivity.ConnectivityConstraint to be added to list" required: false schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" responses: 201: description: "Object created" @@ -796,7 +919,8 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityServiceRef" + summary: "creates or updates tapi.connectivity.ConnectivityConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -804,11 +928,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.connectivity.ConnectivityServiceRef.body-param" - description: "tapi.connectivity.ConnectivityServiceRef to be added or updated" + name: "tapi.connectivity.ConnectivityConstraint.body-param" + description: "tapi.connectivity.ConnectivityConstraint to be added or updated" required: false schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" responses: 201: description: "Object created" @@ -819,7 +943,8 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityServiceRef" + summary: "removes tapi.connectivity.ConnectivityConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -831,74 +956,42 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/cost-characteristic/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/cost-characteristic={cost-name}/: + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/coroute-inclusion/: get: tags: - "tapi-connectivity" - description: "returns tapi.topology.CostCharacteristic" + summary: "returns tapi.connectivity.ConnectivityServiceRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" responses: 200: - description: "tapi.topology.CostCharacteristic" + description: "tapi.connectivity.ConnectivityServiceRef" schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" 400: description: "Internal error" post: tags: - "tapi-connectivity" - description: "creates tapi.topology.CostCharacteristic" + summary: "creates tapi.connectivity.ConnectivityServiceRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" + name: "tapi.connectivity.ConnectivityServiceRef.body-param" + description: "tapi.connectivity.ConnectivityServiceRef to be added to list" required: false schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" responses: 201: description: "Object created" @@ -909,24 +1002,20 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.topology.CostCharacteristic" + summary: "creates or updates tapi.connectivity.ConnectivityServiceRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added or updated" + name: "tapi.connectivity.ConnectivityServiceRef.body-param" + description: "tapi.connectivity.ConnectivityServiceRef to be added or updated" required: false schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" responses: 201: description: "Object created" @@ -937,28 +1026,25 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.topology.CostCharacteristic" + summary: "removes tapi.connectivity.ConnectivityServiceRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/diversity-exclusion/: + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/diversity-exclusion/: post: tags: - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceRef" + summary: "creates tapi.connectivity.ConnectivityServiceRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -978,11 +1064,12 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/diversity-exclusion={connectivity-service-uuid}/: - get: + ? /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/diversity-exclusion={connectivity-service-uuid}/ + : get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityServiceRef" + summary: "returns tapi.connectivity.ConnectivityServiceRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1001,10 +1088,11 @@ paths: $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" 400: description: "Internal error" - post: + put: tags: - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceRef" + summary: "creates or updates tapi.connectivity.ConnectivityServiceRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1018,7 +1106,7 @@ paths: type: "string" - in: "body" name: "tapi.connectivity.ConnectivityServiceRef.body-param" - description: "tapi.connectivity.ConnectivityServiceRef to be added to list" + description: "tapi.connectivity.ConnectivityServiceRef to be added or updated" required: false schema: $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" @@ -1027,12 +1115,13 @@ paths: description: "Object created" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + 204: + description: "Object modified" + delete: tags: - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityServiceRef" + summary: "removes tapi.connectivity.ConnectivityServiceRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1044,44 +1133,35 @@ paths: description: "Id of diversity-exclusion" required: true type: "string" - - in: "body" - name: "tapi.connectivity.ConnectivityServiceRef.body-param" - description: "tapi.connectivity.ConnectivityServiceRef to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" responses: - 201: - description: "Object created" 400: description: "Internal error" 204: - description: "Object modified" - delete: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/requested-capacity/: + get: tags: - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityServiceRef" + summary: "returns tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "connectivity-service-uuid" - in: "path" - description: "Id of diversity-exclusion" - required: true - type: "string" responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point/: post: tags: - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceEndPoint" + summary: "creates tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" @@ -1089,12 +1169,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.connectivity.ConnectivityServiceEndPoint.body-param" - description: "tapi.connectivity.ConnectivityServiceEndPoint to be added to\ - \ list" + name: "tapi.common.Capacity.body-param" + description: "tapi.common.Capacity to be added to list" required: false schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" + $ref: "#/definitions/tapi.common.Capacity" responses: 201: description: "Object created" @@ -1102,100 +1181,126 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/: - get: + put: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityServiceEndPoint" + summary: "creates or updates tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" + - in: "body" + name: "tapi.common.Capacity.body-param" + description: "tapi.common.Capacity to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.Capacity" responses: - 200: - description: "tapi.connectivity.ConnectivityServiceEndPoint" - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" + 201: + description: "Object created" 400: description: "Internal error" - post: + 204: + description: "Object modified" + delete: tags: - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceEndPoint" + summary: "removes tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.connectivity.ConnectivityServiceEndPoint.body-param" - description: "tapi.connectivity.ConnectivityServiceEndPoint to be added to\ - \ list" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" responses: - 201: - description: "Object created" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/requested-capacity/total-size/: + get: tags: - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityServiceEndPoint" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" in: "path" - description: "Id of end-point" + description: "Id of connectivity-service" required: true type: "string" - in: "body" - name: "tapi.connectivity.ConnectivityServiceEndPoint.body-param" - description: "tapi.connectivity.ConnectivityServiceEndPoint to be added or\ - \ updated" + name: "tapi.common.CapacityValue.body-param" + description: "tapi.common.CapacityValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" + $ref: "#/definitions/tapi.common.CapacityValue" responses: 201: description: "Object created" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + 409: + description: "Object already exists" + put: tags: - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityServiceEndPoint" + summary: "creates or updates tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" + - in: "body" + name: "tapi.common.CapacityValue.body-param" + description: "tapi.common.CapacityValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" in: "path" - description: "Id of end-point" + description: "Id of connectivity-service" required: true type: "string" responses: @@ -1203,50 +1308,42 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/: + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/schedule/: get: tags: - "tapi-connectivity" - description: "returns tapi.common.Capacity" + summary: "returns tapi.common.TimeRange" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" responses: 200: - description: "tapi.common.Capacity" + description: "tapi.common.TimeRange" schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.common.TimeRange" 400: description: "Internal error" post: tags: - "tapi-connectivity" - description: "creates tapi.common.Capacity" + summary: "creates tapi.common.TimeRange" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - in: "body" - name: "tapi.common.Capacity.body-param" - description: "tapi.common.Capacity to be added to list" + name: "tapi.common.TimeRange.body-param" + description: "tapi.common.TimeRange to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.common.TimeRange" responses: 201: description: "Object created" @@ -1257,24 +1354,20 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.Capacity" + summary: "creates or updates tapi.common.TimeRange" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - in: "body" - name: "tapi.common.Capacity.body-param" - description: "tapi.common.Capacity to be added or updated" + name: "tapi.common.TimeRange.body-param" + description: "tapi.common.TimeRange to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.common.TimeRange" responses: 201: description: "Object created" @@ -1285,50 +1378,51 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.Capacity" + summary: "removes tapi.common.TimeRange" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/: - get: + /data/context/connectivity-context/connectivity-service={uuid}/end-point/: + post: tags: - "tapi-connectivity" - description: "returns tapi.common.BandwidthProfile" + summary: "creates tapi.connectivity.connectivityservice.EndPoint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" + - in: "body" + name: "tapi.connectivity.connectivityservice.EndPoint.body-param" + description: "tapi.connectivity.connectivityservice.EndPoint to be added to\ + \ list" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/: + get: tags: - "tapi-connectivity" - description: "creates tapi.common.BandwidthProfile" + summary: "returns tapi.connectivity.connectivityservice.EndPoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -1340,23 +1434,18 @@ paths: description: "Id of end-point" required: true type: "string" - - in: "body" - name: "tapi.common.BandwidthProfile.body-param" - description: "tapi.common.BandwidthProfile to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" responses: - 201: - description: "Object created" + 200: + description: "tapi.connectivity.connectivityservice.EndPoint" + schema: + $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.BandwidthProfile" + summary: "creates or updates tapi.connectivity.connectivityservice.EndPoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -1369,11 +1458,12 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.BandwidthProfile.body-param" - description: "tapi.common.BandwidthProfile to be added or updated" + name: "tapi.connectivity.connectivityservice.EndPoint.body-param" + description: "tapi.connectivity.connectivityservice.EndPoint to be added or\ + \ updated" required: false schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" responses: 201: description: "Object created" @@ -1384,7 +1474,8 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.BandwidthProfile" + summary: "removes tapi.connectivity.connectivityservice.EndPoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -1401,11 +1492,12 @@ paths: description: "Internal error" 204: description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-burst-size/ - : get: + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/: + get: tags: - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" @@ -1419,15 +1511,16 @@ paths: type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" post: tags: - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + summary: "creates tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" @@ -1440,11 +1533,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.common.Capacity.body-param" + description: "tapi.common.Capacity to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" responses: 201: description: "Object created" @@ -1455,7 +1548,8 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" @@ -1468,11 +1562,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.common.Capacity.body-param" + description: "tapi.common.Capacity to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" responses: 201: description: "Object created" @@ -1483,7 +1577,8 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" @@ -1500,11 +1595,13 @@ paths: description: "Internal error" 204: description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-information-rate/ - : get: + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/total-size/: + get: tags: - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -1526,7 +1623,9 @@ paths: post: tags: - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + summary: "creates tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -1554,7 +1653,9 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -1582,7 +1683,9 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -1599,11 +1702,12 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-burst-size/: - get: + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/connection-end-point={topology-uuid},{node-uuid},{node-edge-point-uuid},{connection-end-point-uuid}/ + : get: tags: - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.connectivity.ConnectionEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1615,17 +1719,41 @@ paths: description: "Id of end-point" required: true type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.connectivity.ConnectionEndPointRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.connectivity.ConnectionEndPointRef" 400: description: "Internal error" + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/name/: post: tags: - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -1638,11 +1766,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -1650,10 +1778,44 @@ paths: description: "Internal error" 409: description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/name={value-name}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -1665,12 +1827,17 @@ paths: description: "Id of end-point" required: true type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -1681,7 +1848,10 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -1693,16 +1863,22 @@ paths: description: "Id of end-point" required: true type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-information-rate/ - : get: + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/odu-connectivity-service-end-point-spec/: + get: tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" + - "tapi-odu" + summary: "returns tapi.odu.OduConnectivityServiceEndPointSpec" + description: "none" parameters: - name: "uuid" in: "path" @@ -1716,15 +1892,16 @@ paths: type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.odu.OduConnectivityServiceEndPointSpec" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.odu.OduConnectivityServiceEndPointSpec" 400: description: "Internal error" post: tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + - "tapi-odu" + summary: "creates tapi.odu.OduConnectivityServiceEndPointSpec" + description: "none" parameters: - name: "uuid" in: "path" @@ -1737,11 +1914,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.odu.OduConnectivityServiceEndPointSpec.body-param" + description: "tapi.odu.OduConnectivityServiceEndPointSpec to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.odu.OduConnectivityServiceEndPointSpec" responses: 201: description: "Object created" @@ -1751,8 +1928,9 @@ paths: description: "Object already exists" put: tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + - "tapi-odu" + summary: "creates or updates tapi.odu.OduConnectivityServiceEndPointSpec" + description: "none" parameters: - name: "uuid" in: "path" @@ -1765,11 +1943,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.odu.OduConnectivityServiceEndPointSpec.body-param" + description: "tapi.odu.OduConnectivityServiceEndPointSpec to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.odu.OduConnectivityServiceEndPointSpec" responses: 201: description: "Object created" @@ -1779,8 +1957,9 @@ paths: description: "Object modified" delete: tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + - "tapi-odu" + summary: "removes tapi.odu.OduConnectivityServiceEndPointSpec" + description: "none" parameters: - name: "uuid" in: "path" @@ -1797,11 +1976,41 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/total-size/: - get: + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/odu-connectivity-service-end-point-spec/accepted-payload-type/ + : get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.OduPayloadType" + description: "This attribute is applicable when the ODU CTP object instance\ + \ represents a lower order ODU CTP Sink at the client layer of the ODUP/ODU[i]j\ + \ or ODUP/ODUj-21 adaptation function. \r\n This attribute\ + \ is a 2-digit Hex code that indicates the new accepted payload type.\r\n\ + \ Valid values are defined in Table 15-8 of ITU-T Recommendation\ + \ G.709 with one additional value UN_INTERPRETABLE." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.OduPayloadType" + schema: + $ref: "#/definitions/tapi.odu.OduPayloadType" + 400: + description: "Internal error" + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/peer-fwd-connectivity-service-end-point/: + get: tags: - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1815,15 +2024,16 @@ paths: type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.connectivity.ConnectivityServiceEndPointRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" 400: description: "Internal error" post: tags: - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + summary: "creates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1836,11 +2046,12 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" responses: 201: description: "Object created" @@ -1851,7 +2062,8 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1864,11 +2076,12 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" responses: 201: description: "Object created" @@ -1879,7 +2092,8 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1896,11 +2110,12 @@ paths: description: "Internal error" 204: description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/connection-end-point={topology-uuid},{node-uuid},{node-edge-point-uuid},{connection-end-point-uuid}/ - : get: + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/protecting-connectivity-service-end-point/: + get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionEndPointRef" + summary: "returns tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1912,38 +2127,48 @@ paths: description: "Id of end-point" required: true type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "node-edge-point-uuid" + responses: + 200: + description: "tapi.connectivity.ConnectivityServiceEndPointRef" + schema: + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" + 400: + description: "Internal error" + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" + parameters: + - name: "uuid" in: "path" - description: "Id of connection-end-point" + description: "Id of connectivity-service" required: true type: "string" - - name: "connection-end-point-uuid" + - name: "local-id" in: "path" - description: "Id of connection-end-point" + description: "Id of end-point" required: true type: "string" + - in: "body" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ to list" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" responses: - 200: - description: "tapi.connectivity.ConnectionEndPointRef" - schema: - $ref: "#/definitions/tapi.connectivity.ConnectionEndPointRef" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/name/: - post: + 409: + description: "Object already exists" + put: tags: - "tapi-connectivity" - description: "creates tapi.common.NameAndValue" + summary: "creates or updates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1956,23 +2181,24 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ or updated" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" responses: 201: description: "Object created" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/name={value-name}/: - get: + 204: + description: "Object modified" + delete: tags: - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" + summary: "removes tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1984,22 +2210,40 @@ paths: description: "Id of end-point" required: true type: "string" - - name: "value-name" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/server-connectivity-service-end-point/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" + parameters: + - name: "uuid" in: "path" - description: "Id of name" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.connectivity.ConnectivityServiceEndPointRef" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" 400: description: "Internal error" post: tags: - "tapi-connectivity" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -2011,17 +2255,13 @@ paths: description: "Id of end-point" required: true type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ to list" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" responses: 201: description: "Object created" @@ -2032,7 +2272,8 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.NameAndValue" + summary: "creates or updates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -2044,17 +2285,13 @@ paths: description: "Id of end-point" required: true type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ or updated" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" responses: 201: description: "Object created" @@ -2065,7 +2302,8 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -2077,11 +2315,6 @@ paths: description: "Id of end-point" required: true type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" responses: 400: description: "Internal error" @@ -2091,7 +2324,8 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.common.ServiceInterfacePointRef" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -2113,7 +2347,8 @@ paths: post: tags: - "tapi-connectivity" - description: "creates tapi.common.ServiceInterfacePointRef" + summary: "creates tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -2141,7 +2376,8 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.ServiceInterfacePointRef" + summary: "creates or updates tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -2169,7 +2405,8 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.ServiceInterfacePointRef" + summary: "removes tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -2186,255 +2423,232 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/exclude-link={topology-uuid},{link-uuid}/: - get: + /data/context/connectivity-context/connectivity-service={uuid}/name/: + post: tags: - "tapi-connectivity" - description: "returns tapi.topology.LinkRef" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of exclude-link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of exclude-link" - required: true - type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/exclude-node={topology-uuid},{node-uuid}/: + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/name={value-name}/: get: tags: - "tapi-connectivity" - description: "returns tapi.topology.NodeRef" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of exclude-node" - required: true - type: "string" - - name: "node-uuid" + - name: "value-name" in: "path" - description: "Id of exclude-node" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.topology.NodeRef" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.topology.NodeRef" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/exclude-path={path-uuid}/: - get: + put: tags: - "tapi-connectivity" - description: "returns tapi.path.computation.PathRef" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "path-uuid" + - name: "value-name" in: "path" - description: "Id of exclude-path" + description: "Id of name" required: true type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/include-link={topology-uuid},{link-uuid}/: - get: + 204: + description: "Object modified" + delete: tags: - "tapi-connectivity" - description: "returns tapi.topology.LinkRef" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-link" - required: true - type: "string" - - name: "link-uuid" + - name: "value-name" in: "path" - description: "Id of include-link" + description: "Id of name" required: true type: "string" responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" 400: description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/include-node={topology-uuid},{node-uuid}/: + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/resilience-constraint/: get: tags: - "tapi-connectivity" - description: "returns tapi.topology.NodeRef" + summary: "returns tapi.connectivity.ResilienceConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-node" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of include-node" - required: true - type: "string" responses: 200: - description: "tapi.topology.NodeRef" + description: "tapi.connectivity.ResilienceConstraint" schema: - $ref: "#/definitions/tapi.topology.NodeRef" + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" 400: description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/include-path={path-uuid}/: - get: + post: tags: - "tapi-connectivity" - description: "returns tapi.path.computation.PathRef" + summary: "creates tapi.connectivity.ResilienceConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "path-uuid" - in: "path" - description: "Id of include-path" - required: true - type: "string" + - in: "body" + name: "tapi.connectivity.ResilienceConstraint.body-param" + description: "tapi.connectivity.ResilienceConstraint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/include-topology={topology-uuid}/: - get: + 409: + description: "Object already exists" + put: tags: - "tapi-connectivity" - description: "returns tapi.topology.TopologyRef" + summary: "creates or updates tapi.connectivity.ResilienceConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-topology" - required: true - type: "string" + - in: "body" + name: "tapi.connectivity.ResilienceConstraint.body-param" + description: "tapi.connectivity.ResilienceConstraint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/latency-characteristic/: - post: + 204: + description: "Object modified" + delete: tags: - "tapi-connectivity" - description: "creates tapi.topology.LatencyCharacteristic" + summary: "removes tapi.connectivity.ResilienceConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" responses: - 201: - description: "Object created" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/latency-characteristic={traffic-property-name}/: + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/: get: tags: - "tapi-connectivity" - description: "returns tapi.topology.LatencyCharacteristic" + summary: "returns tapi.path.computation.RoutingConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" responses: 200: - description: "tapi.topology.LatencyCharacteristic" + description: "tapi.path.computation.RoutingConstraint" schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" 400: description: "Internal error" post: tags: - "tapi-connectivity" - description: "creates tapi.topology.LatencyCharacteristic" + summary: "creates tapi.path.computation.RoutingConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" + name: "tapi.path.computation.RoutingConstraint.body-param" + description: "tapi.path.computation.RoutingConstraint to be added to list" required: false schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" responses: 201: description: "Object created" @@ -2445,24 +2659,20 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.topology.LatencyCharacteristic" + summary: "creates or updates tapi.path.computation.RoutingConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added or updated" + name: "tapi.path.computation.RoutingConstraint.body-param" + description: "tapi.path.computation.RoutingConstraint to be added or updated" required: false schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" responses: 201: description: "Object created" @@ -2473,28 +2683,26 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.topology.LatencyCharacteristic" + summary: "removes tapi.path.computation.RoutingConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/name/: + /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/cost-characteristic/: post: tags: - "tapi-connectivity" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" @@ -2502,11 +2710,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.topology.CostCharacteristic.body-param" + description: "tapi.topology.CostCharacteristic to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.topology.CostCharacteristic" responses: 201: description: "Object created" @@ -2514,78 +2722,54 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/name={value-name}/: + /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/cost-characteristic={cost-name}/: get: tags: - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "value-name" + - name: "cost-name" in: "path" - description: "Id of name" + description: "Id of cost-characteristic" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.topology.CostCharacteristic" schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" + $ref: "#/definitions/tapi.topology.CostCharacteristic" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.NameAndValue" + summary: "creates or updates tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "value-name" + - name: "cost-name" in: "path" - description: "Id of name" + description: "Id of cost-characteristic" required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" + name: "tapi.topology.CostCharacteristic.body-param" + description: "tapi.topology.CostCharacteristic to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.topology.CostCharacteristic" responses: 201: description: "Object created" @@ -2596,16 +2780,18 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "value-name" + - name: "cost-name" in: "path" - description: "Id of name" + description: "Id of cost-characteristic" required: true type: "string" responses: @@ -2613,63 +2799,80 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/: - get: + /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/latency-characteristic/: + post: tags: - "tapi-connectivity" - description: "returns tapi.common.Capacity" + summary: "creates tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - in: "body" + name: "tapi.topology.LatencyCharacteristic.body-param" + description: "tapi.topology.LatencyCharacteristic to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + ? /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/ + : get: tags: - "tapi-connectivity" - description: "creates tapi.common.Capacity" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - in: "body" - name: "tapi.common.Capacity.body-param" - description: "tapi.common.Capacity to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.Capacity" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" responses: - 201: - description: "Object created" + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.Capacity" + summary: "creates or updates tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" - in: "body" - name: "tapi.common.Capacity.body-param" - description: "tapi.common.Capacity to be added or updated" + name: "tapi.topology.LatencyCharacteristic.body-param" + description: "tapi.topology.LatencyCharacteristic to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" responses: 201: description: "Object created" @@ -2680,75 +2883,96 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.Capacity" + summary: "removes tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/: - get: + /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/risk-diversity-characteristic/: + post: tags: - "tapi-connectivity" - description: "returns tapi.common.BandwidthProfile" + summary: "creates tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - in: "body" + name: "tapi.topology.RiskCharacteristic.body-param" + description: "tapi.topology.RiskCharacteristic to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + ? /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/ + : get: tags: - "tapi-connectivity" - description: "creates tapi.common.BandwidthProfile" + summary: "returns tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - in: "body" - name: "tapi.common.BandwidthProfile.body-param" - description: "tapi.common.BandwidthProfile to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-diversity-characteristic" + required: true + type: "string" responses: - 201: - description: "Object created" + 200: + description: "tapi.topology.RiskCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.BandwidthProfile" + summary: "creates or updates tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-diversity-characteristic" + required: true + type: "string" - in: "body" - name: "tapi.common.BandwidthProfile.body-param" - description: "tapi.common.BandwidthProfile to be added or updated" + name: "tapi.topology.RiskCharacteristic.body-param" + description: "tapi.topology.RiskCharacteristic to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.topology.RiskCharacteristic" responses: 201: description: "Object created" @@ -2759,75 +2983,95 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.BandwidthProfile" + summary: "removes tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-diversity-characteristic" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/committed-burst-size/: - get: + /data/context/connectivity-context/connectivity-service={uuid}/topology-constraint/: + post: tags: - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" + summary: "creates tapi.path.computation.TopologyConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - in: "body" + name: "tapi.path.computation.TopologyConstraint.body-param" + description: "tapi.path.computation.TopologyConstraint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/topology-constraint={local-id}/: + get: tags: - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + summary: "returns tapi.path.computation.TopologyConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" responses: - 201: - description: "Object created" + 200: + description: "tapi.path.computation.TopologyConstraint" + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.path.computation.TopologyConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.path.computation.TopologyConstraint.body-param" + description: "tapi.path.computation.TopologyConstraint to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" responses: 201: description: "Object created" @@ -2838,52 +3082,49 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.path.computation.TopologyConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/committed-information-rate/: - get: + /data/context/connectivity-context/connectivity-service={uuid}/topology-constraint={local-id}/name/: + post: tags: - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" + - name: "local-id" in: "path" - description: "Id of connectivity-service" + description: "Id of topology-constraint" required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -2891,101 +3132,66 @@ paths: description: "Internal error" 409: description: "Object already exists" - put: + /data/context/connectivity-context/connectivity-service={uuid}/topology-constraint={local-id}/name={value-name}/: + get: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" + - name: "local-id" in: "path" - description: "Id of connectivity-service" + description: "Id of topology-constraint" required: true type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" + - name: "value-name" in: "path" - description: "Id of connectivity-service" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: + put: tags: - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" + - name: "local-id" in: "path" - description: "Id of connectivity-service" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -2996,52 +3202,46 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" + - name: "local-id" in: "path" - description: "Id of connectivity-service" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" required: true type: "string" responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" + 204: + description: "Object deleted" + /data/context/name/: post: tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + - "tapi-common" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -3049,22 +3249,46 @@ paths: description: "Internal error" 409: description: "Object already exists" + /data/context/name={value-name}/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" put: tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + - "tapi-common" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - - name: "uuid" + - name: "value-name" in: "path" - description: "Id of connectivity-service" + description: "Id of name" required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -3074,12 +3298,15 @@ paths: description: "Object modified" delete: tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + - "tapi-common" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - - name: "uuid" + - name: "value-name" in: "path" - description: "Id of connectivity-service" + description: "Id of name" required: true type: "string" responses: @@ -3087,40 +3314,33 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/total-size/: + /data/context/notification-context/: get: tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" + - "tapi-notification" + summary: "returns tapi.notification.context.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: [] responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.notification.context.NotificationContext" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.notification.context.NotificationContext" 400: description: "Internal error" post: tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + - "tapi-notification" + summary: "creates tapi.notification.context.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.notification.context.NotificationContext.body-param" + description: "tapi.notification.context.NotificationContext to be added to\ + \ list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.notification.context.NotificationContext" responses: 201: description: "Object created" @@ -3130,20 +3350,17 @@ paths: description: "Object already exists" put: tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + - "tapi-notification" + summary: "creates or updates tapi.notification.context.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.notification.context.NotificationContext.body-param" + description: "tapi.notification.context.NotificationContext to be added or\ + \ updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.notification.context.NotificationContext" responses: 201: description: "Object created" @@ -3153,53 +3370,29 @@ paths: description: "Object modified" delete: tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" + - "tapi-notification" + summary: "removes tapi.notification.context.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: [] responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/resilience-type/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.ResilienceType" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.ResilienceType" - schema: - $ref: "#/definitions/tapi.topology.ResilienceType" - 400: - description: "Internal error" + /data/context/notification-context/notif-subscription/: post: tags: - - "tapi-connectivity" - description: "creates tapi.topology.ResilienceType" + - "tapi-notification" + summary: "creates tapi.notification.NotificationSubscriptionService" + description: "none" parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - in: "body" - name: "tapi.topology.ResilienceType.body-param" - description: "tapi.topology.ResilienceType to be added to list" + name: "tapi.notification.NotificationSubscriptionService.body-param" + description: "tapi.notification.NotificationSubscriptionService to be added\ + \ to list" required: false schema: - $ref: "#/definitions/tapi.topology.ResilienceType" + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" responses: 201: description: "Object created" @@ -3207,22 +3400,43 @@ paths: description: "Internal error" 409: description: "Object already exists" + /data/context/notification-context/notif-subscription={uuid}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NotificationSubscriptionService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.NotificationSubscriptionService" + schema: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + 400: + description: "Internal error" put: tags: - - "tapi-connectivity" - description: "creates or updates tapi.topology.ResilienceType" + - "tapi-notification" + summary: "creates or updates tapi.notification.NotificationSubscriptionService" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" required: true type: "string" - in: "body" - name: "tapi.topology.ResilienceType.body-param" - description: "tapi.topology.ResilienceType to be added or updated" + name: "tapi.notification.NotificationSubscriptionService.body-param" + description: "tapi.notification.NotificationSubscriptionService to be added\ + \ or updated" required: false schema: - $ref: "#/definitions/tapi.topology.ResilienceType" + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" responses: 201: description: "Object created" @@ -3232,12 +3446,13 @@ paths: description: "Object modified" delete: tags: - - "tapi-connectivity" - description: "removes tapi.topology.ResilienceType" + - "tapi-notification" + summary: "removes tapi.notification.NotificationSubscriptionService" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" required: true type: "string" responses: @@ -3245,23 +3460,26 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/risk-diversity-characteristic/: + /data/context/notification-context/notif-subscription={uuid}/name/: post: tags: - - "tapi-connectivity" - description: "creates tapi.topology.RiskCharacteristic" + - "tapi-notification" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" required: true type: "string" - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added to list" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -3269,78 +3487,56 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/risk-diversity-characteristic={risk-characteristic-name}/: + /data/context/notification-context/notif-subscription={uuid}/name={value-name}/: get: tags: - - "tapi-connectivity" - description: "returns tapi.topology.RiskCharacteristic" + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" required: true type: "string" - - name: "risk-characteristic-name" + - name: "value-name" in: "path" - description: "Id of risk-diversity-characteristic" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.topology.RiskCharacteristic" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - responses: - 201: - description: "Object created" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - - "tapi-connectivity" - description: "creates or updates tapi.topology.RiskCharacteristic" + - "tapi-notification" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" required: true type: "string" - - name: "risk-characteristic-name" + - name: "value-name" in: "path" - description: "Id of risk-diversity-characteristic" + description: "Id of name" required: true type: "string" - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added or updated" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -3350,17 +3546,20 @@ paths: description: "Object modified" delete: tags: - - "tapi-connectivity" - description: "removes tapi.topology.RiskCharacteristic" + - "tapi-notification" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" required: true type: "string" - - name: "risk-characteristic-name" + - name: "value-name" in: "path" - description: "Id of risk-diversity-characteristic" + description: "Id of name" required: true type: "string" responses: @@ -3368,113 +3567,95 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/schedule/: + /data/context/notification-context/notif-subscription={uuid}/notification-channel/: get: tags: - - "tapi-connectivity" - description: "returns tapi.common.TimeRange" + - "tapi-notification" + summary: "returns tapi.notification.NotificationChannel" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" required: true type: "string" responses: 200: - description: "tapi.common.TimeRange" + description: "tapi.notification.NotificationChannel" schema: - $ref: "#/definitions/tapi.common.TimeRange" + $ref: "#/definitions/tapi.notification.NotificationChannel" 400: description: "Internal error" - post: + /data/context/notification-context/notif-subscription={uuid}/notification-channel/name={value-name}/: + get: tags: - - "tapi-connectivity" - description: "creates tapi.common.TimeRange" + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" required: true type: "string" - - in: "body" - name: "tapi.common.TimeRange.body-param" - description: "tapi.common.TimeRange to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.TimeRange" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.TimeRange" - parameters: - - name: "uuid" + - name: "value-name" in: "path" - description: "Id of connectivity-service" + description: "Id of name" required: true type: "string" - - in: "body" - name: "tapi.common.TimeRange.body-param" - description: "tapi.common.TimeRange to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.TimeRange" responses: - 201: - description: "Object created" + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/: + get: tags: - - "tapi-connectivity" - description: "removes tapi.common.TimeRange" + - "tapi-notification" + summary: "returns tapi.notification.Notification" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of connectivity-service" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" required: true type: "string" responses: + 200: + description: "tapi.notification.Notification" + schema: + $ref: "#/definitions/tapi.notification.Notification" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/name/: - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/name={value-name}/: + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/additional-info={value-name}/: get: tags: - - "tapi-common" - description: "returns tapi.common.NameAndValue" + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" - name: "value-name" in: "path" - description: "Id of name" + description: "Id of additional-info" required: true type: "string" responses: @@ -3484,151 +3665,101 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/changed-attributes={value-name}/: + get: tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" + - "tapi-notification" + summary: "returns tapi.notification.NameAndValueChange" + description: "none" parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" - name: "value-name" in: "path" - description: "Id of name" + description: "Id of changed-attributes" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.notification.NameAndValueChange" + schema: + $ref: "#/definitions/tapi.notification.NameAndValueChange" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/name={value-name}/: + get: tags: - - "tapi-common" - description: "creates or updates tapi.common.NameAndValue" + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - - name: "value-name" + - name: "uuid" in: "path" - description: "Id of name" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.NameAndValue" - parameters: - name: "value-name" in: "path" description: "Id of name" required: true type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NotificationContext" - parameters: [] responses: 200: - description: "tapi.notification.NotificationContext" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.notification.NotificationContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationContext" - parameters: - - in: "body" - name: "tapi.notification.NotificationContext.body-param" - description: "tapi.notification.NotificationContext to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.notification.NotificationContext" - parameters: - - in: "body" - name: "tapi.notification.NotificationContext.body-param" - description: "tapi.notification.NotificationContext to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.notification.NotificationContext" - parameters: [] - responses: + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription/: - post: + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/target-object-name={value-name}/: + get: tags: - "tapi-notification" - description: "creates tapi.notification.NotificationSubscriptionService" + summary: "returns tapi.common.NameAndValue" + description: "none" parameters: - - in: "body" - name: "tapi.notification.NotificationSubscriptionService.body-param" - description: "tapi.notification.NotificationSubscriptionService to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of target-object-name" + required: true + type: "string" responses: - 201: - description: "Object created" + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/: + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/: get: tags: - "tapi-notification" - description: "returns tapi.notification.NotificationSubscriptionService" + summary: "returns tapi.notification.SubscriptionFilter" + description: "none" parameters: - name: "uuid" in: "path" @@ -3637,15 +3768,16 @@ paths: type: "string" responses: 200: - description: "tapi.notification.NotificationSubscriptionService" + description: "tapi.notification.SubscriptionFilter" schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" 400: description: "Internal error" post: tags: - "tapi-notification" - description: "creates tapi.notification.NotificationSubscriptionService" + summary: "creates tapi.notification.SubscriptionFilter" + description: "none" parameters: - name: "uuid" in: "path" @@ -3653,12 +3785,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.notification.NotificationSubscriptionService.body-param" - description: "tapi.notification.NotificationSubscriptionService to be added\ - \ to list" + name: "tapi.notification.SubscriptionFilter.body-param" + description: "tapi.notification.SubscriptionFilter to be added to list" required: false schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" responses: 201: description: "Object created" @@ -3669,7 +3800,8 @@ paths: put: tags: - "tapi-notification" - description: "creates or updates tapi.notification.NotificationSubscriptionService" + summary: "creates or updates tapi.notification.SubscriptionFilter" + description: "none" parameters: - name: "uuid" in: "path" @@ -3677,12 +3809,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.notification.NotificationSubscriptionService.body-param" - description: "tapi.notification.NotificationSubscriptionService to be added\ - \ or updated" + name: "tapi.notification.SubscriptionFilter.body-param" + description: "tapi.notification.SubscriptionFilter to be added or updated" required: false schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" responses: 201: description: "Object created" @@ -3693,7 +3824,8 @@ paths: delete: tags: - "tapi-notification" - description: "removes tapi.notification.NotificationSubscriptionService" + summary: "removes tapi.notification.SubscriptionFilter" + description: "none" parameters: - name: "uuid" in: "path" @@ -3705,11 +3837,14 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/name/: + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name/: post: tags: - "tapi-notification" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -3729,11 +3864,14 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/name={value-name}/: + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name={value-name}/: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -3752,38 +3890,13 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -3811,7 +3924,10 @@ paths: delete: tags: - "tapi-notification" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -3828,123 +3944,133 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/notification-channel/: + /data/context/notification-context/notification={uuid}/: get: tags: - "tapi-notification" - description: "returns tapi.notification.NotificationChannel" + summary: "returns tapi.notification.notificationcontext.Notification" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of notification" required: true type: "string" responses: 200: - description: "tapi.notification.NotificationChannel" + description: "tapi.notification.notificationcontext.Notification" schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" + $ref: "#/definitions/tapi.notification.notificationcontext.Notification" 400: description: "Internal error" - post: + /data/context/notification-context/notification={uuid}/additional-info={value-name}/: + get: tags: - "tapi-notification" - description: "creates tapi.notification.NotificationChannel" + summary: "returns tapi.common.NameAndValue" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of additional-info" required: true type: "string" - - in: "body" - name: "tapi.notification.NotificationChannel.body-param" - description: "tapi.notification.NotificationChannel to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" responses: - 201: - description: "Object created" + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + /data/context/notification-context/notification={uuid}/alarm-info/: + get: tags: - - "tapi-notification" - description: "creates or updates tapi.notification.NotificationChannel" + - "tapi-oam" + summary: "returns tapi.oam.AlarmInfo" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of notification" required: true type: "string" - - in: "body" - name: "tapi.notification.NotificationChannel.body-param" - description: "tapi.notification.NotificationChannel to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" responses: - 201: - description: "Object created" + 200: + description: "tapi.oam.AlarmInfo" + schema: + $ref: "#/definitions/tapi.oam.AlarmInfo" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + /data/context/notification-context/notification={uuid}/changed-attributes={value-name}/: + get: tags: - "tapi-notification" - description: "removes tapi.notification.NotificationChannel" + summary: "returns tapi.notification.NameAndValueChange" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of changed-attributes" required: true type: "string" responses: + 200: + description: "tapi.notification.NameAndValueChange" + schema: + $ref: "#/definitions/tapi.notification.NameAndValueChange" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/notification-channel/name/: - post: + /data/context/notification-context/notification={uuid}/name={value-name}/: + get: tags: - "tapi-notification" - description: "creates tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/notification-channel/name={value-name}/: + /data/context/notification-context/notification={uuid}/target-object-name={value-name}/: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of notification" required: true type: "string" - name: "value-name" in: "path" - description: "Id of name" + description: "Id of target-object-name" required: true type: "string" responses: @@ -3954,198 +4080,247 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: + /data/context/notification-context/notification={uuid}/tca-info/: + get: tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" + - "tapi-oam" + summary: "returns tapi.oam.TcaInfo" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of notification" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.oam.TcaInfo" + schema: + $ref: "#/definitions/tapi.oam.TcaInfo" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + /data/context/notification-context/notification={uuid}/tca-info/oam-job/: + get: tags: - - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" + - "tapi-oam" + summary: "returns tapi.oam.OamJobRef" + description: "MEF 35.1\r\n Identification of the PM Session for\ + \ which the TCA Function was configured." parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of notification" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.oam.OamJobRef" + schema: + $ref: "#/definitions/tapi.oam.OamJobRef" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + /data/context/notification-context/notification={uuid}/tca-info/threshold-parameter/: + get: tags: - - "tapi-notification" - description: "removes tapi.common.NameAndValue" + - "tapi-oam" + summary: "returns tapi.oam.ThresholdParameter" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of notification" required: true type: "string" responses: + 200: + description: "tapi.oam.ThresholdParameter" + schema: + $ref: "#/definitions/tapi.oam.ThresholdParameter" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/: + /data/context/notification-context/notification={uuid}/tca-info/threshold-parameter/pm-parameter-above-thrs/: get: tags: - - "tapi-notification" - description: "returns tapi.notification.Notification" + - "tapi-oam" + summary: "returns tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" in: "path" description: "Id of notification" required: true type: "string" responses: 200: - description: "tapi.notification.Notification" + description: "tapi.oam.PmParameterValue" schema: - $ref: "#/definitions/tapi.notification.Notification" + $ref: "#/definitions/tapi.oam.PmParameterValue" 400: description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/additional-info={value-name}/: + /data/context/notification-context/notification={uuid}/tca-info/threshold-parameter/pm-parameter-below-thrs/: get: tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" + - "tapi-oam" + summary: "returns tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" in: "path" description: "Id of notification" required: true type: "string" - - name: "value-name" - in: "path" - description: "Id of additional-info" - required: true - type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.oam.PmParameterValue" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.oam.PmParameterValue" 400: description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/alarm-info/: + /data/context/notification-context/notification={uuid}/tca-info/threshold-parameter/pm-parameter-clear-thrs/: get: tags: - - "tapi-notification" - description: "returns tapi.notification.AlarmInfo" + - "tapi-oam" + summary: "returns tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" in: "path" description: "Id of notification" required: true type: "string" responses: 200: - description: "tapi.notification.AlarmInfo" + description: "tapi.oam.PmParameterValue" schema: - $ref: "#/definitions/tapi.notification.AlarmInfo" + $ref: "#/definitions/tapi.oam.PmParameterValue" 400: description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/changed-attributes={value-name}/: + /data/context/oam-context/: get: tags: - - "tapi-notification" - description: "returns tapi.notification.NameAndValueChange" + - "tapi-oam" + summary: "returns tapi.oam.context.OamContext" + description: "Augments the base TAPI Context with OamService information" + parameters: [] + responses: + 200: + description: "tapi.oam.context.OamContext" + schema: + $ref: "#/definitions/tapi.oam.context.OamContext" + 400: + description: "Internal error" + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.context.OamContext" + description: "Augments the base TAPI Context with OamService information" + parameters: + - in: "body" + name: "tapi.oam.context.OamContext.body-param" + description: "tapi.oam.context.OamContext to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.context.OamContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.context.OamContext" + description: "Augments the base TAPI Context with OamService information" + parameters: + - in: "body" + name: "tapi.oam.context.OamContext.body-param" + description: "tapi.oam.context.OamContext to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.context.OamContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.context.OamContext" + description: "Augments the base TAPI Context with OamService information" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/meg={uuid}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.oamcontext.Meg" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of meg" required: true type: "string" - - name: "notification-uuid" + responses: + 200: + description: "tapi.oam.oamcontext.Meg" + schema: + $ref: "#/definitions/tapi.oam.oamcontext.Meg" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mep={local-id}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.meg.Mep" + description: "1. ME may have 0 MEPs (case of transit domains where at least\ + \ 1 MIP is present)\r\n 2. ME may have 1 MEP (case of edge\ + \ domaind, where the peer MEP is ouside the managed domain)\r\n \ + \ 3. ME may have 2 MEPs" + parameters: + - name: "uuid" in: "path" - description: "Id of notification" + description: "Id of meg" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of changed-attributes" + description: "Id of mep" required: true type: "string" responses: 200: - description: "tapi.notification.NameAndValueChange" + description: "tapi.oam.meg.Mep" schema: - $ref: "#/definitions/tapi.notification.NameAndValueChange" + $ref: "#/definitions/tapi.oam.meg.Mep" 400: description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/name={value-name}/: + /data/context/oam-context/meg={uuid}/mep={local-id}/name={value-name}/: get: tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of meg" required: true type: "string" - - name: "notification-uuid" + - name: "local-id" in: "path" - description: "Id of notification" + description: "Id of mep" required: true type: "string" - name: "value-name" @@ -4160,247 +4335,246 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/target-object-name={value-name}/: + /data/context/oam-context/meg={uuid}/mep={local-id}/odu-mep-spec/: get: tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" + - "tapi-odu" + summary: "returns tapi.odu.OduMepSpec" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" + description: "Id of meg" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of target-object-name" + description: "Id of mep" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.odu.OduMepSpec" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.odu.OduMepSpec" 400: description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/tca-info/: + /data/context/oam-context/meg={uuid}/mep={local-id}/odu-mep-spec/odu-defect/: get: tags: - - "tapi-notification" - description: "returns tapi.notification.TcaInfo" + - "tapi-odu" + summary: "returns tapi.odu.OduDefectPac" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of meg" required: true type: "string" - - name: "notification-uuid" + - name: "local-id" in: "path" - description: "Id of notification" + description: "Id of mep" required: true type: "string" responses: 200: - description: "tapi.notification.TcaInfo" + description: "tapi.odu.OduDefectPac" schema: - $ref: "#/definitions/tapi.notification.TcaInfo" + $ref: "#/definitions/tapi.odu.OduDefectPac" 400: description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/subscription-filter/: + /data/context/oam-context/meg={uuid}/mep={local-id}/odu-mep-spec/odu-mep/: get: tags: - - "tapi-notification" - description: "returns tapi.notification.SubscriptionFilter" + - "tapi-odu" + summary: "returns tapi.odu.OduMepPac" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mep" required: true type: "string" responses: 200: - description: "tapi.notification.SubscriptionFilter" + description: "tapi.odu.OduMepPac" schema: - $ref: "#/definitions/tapi.notification.SubscriptionFilter" + $ref: "#/definitions/tapi.odu.OduMepPac" 400: description: "Internal error" - post: + /data/context/oam-context/meg={uuid}/mep={local-id}/odu-mep-spec/odu-mep/deg-thr/: + get: tags: - - "tapi-notification" - description: "creates tapi.notification.SubscriptionFilter" + - "tapi-odu" + summary: "returns tapi.odu.DegThr" + description: "This attribute indicates the threshold level for declaring a performance\ + \ monitoring (PM) Second to be bad. The value of the threshold can be provisioned\ + \ in terms of number of errored blocks or in terms of percentage of errored\ + \ blocks. For percentage-based specification, in order to support provision\ + \ of less than 1%, the specification consists of two fields. The first field\ + \ indicates the granularity of percentage. For examples, in 1%, in 0.1%, or\ + \ in 0.01%, etc. The second field indicates the multiple of the granularity.\ + \ For number of errored block based, the value is a positive integer." parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of meg" required: true type: "string" - - in: "body" - name: "tapi.notification.SubscriptionFilter.body-param" - description: "tapi.notification.SubscriptionFilter to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.SubscriptionFilter" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.notification.SubscriptionFilter" - parameters: - - name: "uuid" + - name: "local-id" in: "path" - description: "Id of notif-subscription" + description: "Id of mep" required: true type: "string" - - in: "body" - name: "tapi.notification.SubscriptionFilter.body-param" - description: "tapi.notification.SubscriptionFilter to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.SubscriptionFilter" responses: - 201: - description: "Object created" + 200: + description: "tapi.odu.DegThr" + schema: + $ref: "#/definitions/tapi.odu.DegThr" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + /data/context/oam-context/meg={uuid}/mep={local-id}/odu-mep-spec/odu-ncm/: + get: tags: - - "tapi-notification" - description: "removes tapi.notification.SubscriptionFilter" + - "tapi-odu" + summary: "returns tapi.odu.OduNcmPac" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mep" required: true type: "string" responses: + 200: + description: "tapi.odu.OduNcmPac" + schema: + $ref: "#/definitions/tapi.odu.OduNcmPac" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name/: - post: + /data/context/oam-context/meg={uuid}/mep={local-id}/odu-mep-spec/odu-pm/: + get: tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" + - "tapi-odu" + summary: "returns tapi.odu.OduPmPac" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mep" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.odu.OduPmPac" + schema: + $ref: "#/definitions/tapi.odu.OduPmPac" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name={value-name}/: + /data/context/oam-context/meg={uuid}/mep={local-id}/odu-mep-spec/odu-pm/uas/: get: tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" + - "tapi-odu" + summary: "returns tapi.odu.UasChoice" + description: "UnAvailable Second" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of meg" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of name" + description: "Id of mep" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.odu.UasChoice" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.odu.UasChoice" 400: description: "Internal error" - post: + /data/context/oam-context/meg={uuid}/mep={local-id}/odu-mep-spec/odu-tcm/: + get: tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" + - "tapi-odu" + summary: "returns tapi.odu.OduTcmMepPac" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of meg" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of name" + description: "Id of mep" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.odu.OduTcmMepPac" + schema: + $ref: "#/definitions/tapi.odu.OduTcmMepPac" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + /data/context/oam-context/meg={uuid}/mip={local-id}/: + get: tags: - - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" + - "tapi-oam" + summary: "returns tapi.oam.meg.Mip" + description: "ME may 0, 1, or more MIPs" parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of meg" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of name" + description: "Id of mip" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.oam.meg.Mip" + schema: + $ref: "#/definitions/tapi.oam.meg.Mip" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + /data/context/oam-context/meg={uuid}/mip={local-id}/name={value-name}/: + get: tags: - - "tapi-notification" - description: "removes tapi.common.NameAndValue" + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of notif-subscription" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mip" required: true type: "string" - name: "value-name" @@ -4409,180 +4583,269 @@ paths: required: true type: "string" responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notification={uuid}/: + /data/context/oam-context/meg={uuid}/mip={local-id}/odu-mip-spec/: get: tags: - - "tapi-notification" - description: "returns tapi.notification.Notification" + - "tapi-odu" + summary: "returns tapi.odu.OduMipSpec" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notification" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mip" required: true type: "string" responses: 200: - description: "tapi.notification.Notification" + description: "tapi.odu.OduMipSpec" schema: - $ref: "#/definitions/tapi.notification.Notification" + $ref: "#/definitions/tapi.odu.OduMipSpec" 400: description: "Internal error" - /data/context/notification-context/notification={uuid}/additional-info={value-name}/: + /data/context/oam-context/meg={uuid}/mip={local-id}/odu-mip-spec/odu-defect/: get: tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" + - "tapi-odu" + summary: "returns tapi.odu.OduDefectPac" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notification" + description: "Id of meg" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of additional-info" + description: "Id of mip" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.odu.OduDefectPac" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.odu.OduDefectPac" 400: description: "Internal error" - /data/context/notification-context/notification={uuid}/alarm-info/: + /data/context/oam-context/meg={uuid}/mip={local-id}/odu-mip-spec/odu-mip/: get: tags: - - "tapi-notification" - description: "returns tapi.notification.AlarmInfo" + - "tapi-odu" + summary: "returns tapi.odu.OduMipPac" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notification" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mip" required: true type: "string" responses: 200: - description: "tapi.notification.AlarmInfo" + description: "tapi.odu.OduMipPac" schema: - $ref: "#/definitions/tapi.notification.AlarmInfo" + $ref: "#/definitions/tapi.odu.OduMipPac" 400: description: "Internal error" - /data/context/notification-context/notification={uuid}/changed-attributes={value-name}/: + /data/context/oam-context/meg={uuid}/mip={local-id}/odu-mip-spec/odu-mip/deg-thr/: get: tags: - - "tapi-notification" - description: "returns tapi.notification.NameAndValueChange" + - "tapi-odu" + summary: "returns tapi.odu.DegThr" + description: "This attribute indicates the threshold level for declaring a performance\ + \ monitoring (PM) Second to be bad. The value of the threshold can be provisioned\ + \ in terms of number of errored blocks or in terms of percentage of errored\ + \ blocks. For percentage-based specification, in order to support provision\ + \ of less than 1%, the specification consists of two fields. The first field\ + \ indicates the granularity of percentage. For examples, in 1%, in 0.1%, or\ + \ in 0.01%, etc. The second field indicates the multiple of the granularity.\ + \ For number of errored block based, the value is a positive integer." parameters: - name: "uuid" in: "path" - description: "Id of notification" + description: "Id of meg" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of changed-attributes" + description: "Id of mip" required: true type: "string" responses: 200: - description: "tapi.notification.NameAndValueChange" + description: "tapi.odu.DegThr" schema: - $ref: "#/definitions/tapi.notification.NameAndValueChange" + $ref: "#/definitions/tapi.odu.DegThr" 400: description: "Internal error" - /data/context/notification-context/notification={uuid}/name={value-name}/: + /data/context/oam-context/meg={uuid}/mip={local-id}/odu-mip-spec/odu-ncm/: get: tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" + - "tapi-odu" + summary: "returns tapi.odu.OduNcmPac" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notification" + description: "Id of meg" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of name" + description: "Id of mip" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.odu.OduNcmPac" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.odu.OduNcmPac" 400: description: "Internal error" - /data/context/notification-context/notification={uuid}/target-object-name={value-name}/: + /data/context/oam-context/meg={uuid}/mip={local-id}/odu-mip-spec/odu-pm/: get: tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" + - "tapi-odu" + summary: "returns tapi.odu.OduPmPac" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of notification" + description: "Id of meg" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of target-object-name" + description: "Id of mip" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.odu.OduPmPac" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.odu.OduPmPac" 400: description: "Internal error" - /data/context/notification-context/notification={uuid}/tca-info/: + /data/context/oam-context/meg={uuid}/mip={local-id}/odu-mip-spec/odu-pm/uas/: get: tags: - - "tapi-notification" - description: "returns tapi.notification.TcaInfo" + - "tapi-odu" + summary: "returns tapi.odu.UasChoice" + description: "UnAvailable Second" parameters: - name: "uuid" in: "path" - description: "Id of notification" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mip" required: true type: "string" responses: 200: - description: "tapi.notification.TcaInfo" + description: "tapi.odu.UasChoice" schema: - $ref: "#/definitions/tapi.notification.TcaInfo" + $ref: "#/definitions/tapi.odu.UasChoice" 400: description: "Internal error" - /data/context/oam-context/: + /data/context/oam-context/meg={uuid}/mip={local-id}/odu-mip-spec/odu-tcm/: + get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.OduTcmMipPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mip" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.OduTcmMipPac" + schema: + $ref: "#/definitions/tapi.odu.OduTcmMipPac" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/name={value-name}/: get: tags: - "tapi-oam" - description: "returns tapi.oam.OamContext" - parameters: [] + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/odu-meg-spec/: + get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.OduMegSpec" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" responses: 200: - description: "tapi.oam.OamContext" + description: "tapi.odu.OduMegSpec" schema: - $ref: "#/definitions/tapi.oam.OamContext" + $ref: "#/definitions/tapi.odu.OduMegSpec" 400: description: "Internal error" + /data/context/oam-context/oam-job/: post: tags: - "tapi-oam" - description: "creates tapi.oam.OamContext" + summary: "creates tapi.oam.OamJob" + description: "none" parameters: - in: "body" - name: "tapi.oam.context.OamContext.body-param" - description: "tapi.oam.OamContext to be added to list" + name: "tapi.oam.OamJob.body-param" + description: "tapi.oam.OamJob to be added to list" required: false schema: - $ref: "#/definitions/tapi.oam.OamContext" + $ref: "#/definitions/tapi.oam.OamJob" responses: 201: description: "Object created" @@ -4590,17 +4853,42 @@ paths: description: "Internal error" 409: description: "Object already exists" + /data/context/oam-context/oam-job={uuid}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.OamJob" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.OamJob" + schema: + $ref: "#/definitions/tapi.oam.OamJob" + 400: + description: "Internal error" put: tags: - "tapi-oam" - description: "creates or updates tapi.oam.OamContext" + summary: "creates or updates tapi.oam.OamJob" + description: "none" parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" - in: "body" - name: "tapi.oam.context.OamContext.body-param" - description: "tapi.oam.OamContext to be added or updated" + name: "tapi.oam.OamJob.body-param" + description: "tapi.oam.OamJob to be added or updated" required: false schema: - $ref: "#/definitions/tapi.oam.OamContext" + $ref: "#/definitions/tapi.oam.OamJob" responses: 201: description: "Object created" @@ -4611,257 +4899,344 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.oam.OamContext" - parameters: [] + summary: "removes tapi.oam.OamJob" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/meg={uuid}/: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/: get: tags: - "tapi-oam" - description: "returns tapi.oam.oamcontext.Meg" + summary: "returns tapi.oam.CurrentData" + description: "Granularity period of the CurrentData identifies the specific\ + \ CurrentData instance in the scope of this OamJob.\r\n For\ + \ example, typically at least\r\n one 15min and\r\n \ + \ one 24hr;\r\n optionally one additional configurable\ + \ (< 15min)" parameters: - name: "uuid" in: "path" - description: "Id of meg" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" required: true type: "string" responses: 200: - description: "tapi.oam.oamcontext.Meg" + description: "tapi.oam.CurrentData" schema: - $ref: "#/definitions/tapi.oam.oamcontext.Meg" + $ref: "#/definitions/tapi.oam.CurrentData" 400: description: "Internal error" - /data/context/oam-context/meg={uuid}/mep={local-id}/: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/elapsed-time/: get: tags: - "tapi-oam" - description: "returns tapi.oam.meg.Mep" + summary: "returns tapi.common.TimeInterval" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of meg" + description: "Id of oam-job" required: true type: "string" - name: "local-id" in: "path" - description: "Id of mep" + description: "Id of current-data" required: true type: "string" responses: 200: - description: "tapi.oam.meg.Mep" + description: "tapi.common.TimeInterval" schema: - $ref: "#/definitions/tapi.oam.meg.Mep" + $ref: "#/definitions/tapi.common.TimeInterval" 400: description: "Internal error" - /data/context/oam-context/meg={uuid}/mep={local-id}/name={value-name}/: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/elapsed-time/period={unit}/: get: tags: - "tapi-oam" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.TimePeriod" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of meg" + description: "Id of oam-job" required: true type: "string" - name: "local-id" in: "path" - description: "Id of mep" + description: "Id of current-data" required: true type: "string" - - name: "value-name" + - name: "unit" in: "path" - description: "Id of name" + description: "Id of period" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.common.TimePeriod" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.common.TimePeriod" 400: description: "Internal error" - /data/context/oam-context/meg={uuid}/mep={local-id}/odu-connection-end-point-spec/: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/: get: tags: - - "tapi-odu" - description: "returns tapi.odu.OduConnectionEndPointSpec" + - "tapi-oam" + summary: "returns tapi.oam.HistoryData" + description: "in case of 24hr Current Data, at least 1 History Data.\r\n \ + \ In case of 15min Current Data, at least 16 History Data.\r\n\ + \ In case of <15min, the number of History Data shall be able\ + \ to cover a span of 4 hours." parameters: - name: "uuid" in: "path" - description: "Id of meg" + description: "Id of oam-job" required: true type: "string" - name: "local-id" in: "path" - description: "Id of mep" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" required: true type: "string" responses: 200: - description: "tapi.odu.OduConnectionEndPointSpec" + description: "tapi.oam.HistoryData" schema: - $ref: "#/definitions/tapi.odu.OduConnectionEndPointSpec" + $ref: "#/definitions/tapi.oam.HistoryData" 400: description: "Internal error" - /data/context/oam-context/meg={uuid}/mep={local-id}/odu-connection-end-point-spec/odu-common/: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/name={value-name}/: get: tags: - - "tapi-odu" - description: "returns tapi.odu.OduCommonPac" + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of meg" + description: "Id of oam-job" required: true type: "string" - name: "local-id" in: "path" - description: "Id of mep" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.odu.OduCommonPac" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.odu.OduCommonPac" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/oam-context/meg={uuid}/mep={local-id}/odu-connection-end-point-spec/odu-ctp/: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/pm-data-pac/: get: tags: - - "tapi-odu" - description: "returns tapi.odu.OduCtpPac" + - "tapi-oam" + summary: "returns tapi.oam.PmDataPac" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of meg" + description: "Id of oam-job" required: true type: "string" - name: "local-id" in: "path" - description: "Id of mep" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" required: true type: "string" responses: 200: - description: "tapi.odu.OduCtpPac" + description: "tapi.oam.PmDataPac" schema: - $ref: "#/definitions/tapi.odu.OduCtpPac" + $ref: "#/definitions/tapi.oam.PmDataPac" 400: description: "Internal error" - /data/context/oam-context/meg={uuid}/mep={local-id}/odu-connection-end-point-spec/odu-protection/: - get: + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/pm-data-pac/granularity-period/ + : get: tags: - - "tapi-odu" - description: "returns tapi.odu.OduProtectionPac" + - "tapi-oam" + summary: "returns tapi.common.TimePeriod" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of meg" + description: "Id of oam-job" required: true type: "string" - name: "local-id" in: "path" - description: "Id of mep" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" required: true type: "string" responses: 200: - description: "tapi.odu.OduProtectionPac" + description: "tapi.common.TimePeriod" schema: - $ref: "#/definitions/tapi.odu.OduProtectionPac" + $ref: "#/definitions/tapi.common.TimePeriod" 400: description: "Internal error" - /data/context/oam-context/meg={uuid}/mep={local-id}/odu-connection-end-point-spec/odu-term-and-adapter/: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/name={value-name}/: get: tags: - - "tapi-odu" - description: "returns tapi.odu.OduTerminationAndClientAdaptationPac" + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of meg" + description: "Id of oam-job" required: true type: "string" - name: "local-id" in: "path" - description: "Id of mep" + description: "Id of current-data" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.odu.OduTerminationAndClientAdaptationPac" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.odu.OduTerminationAndClientAdaptationPac" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/oam-context/meg={uuid}/mep={local-id}/odu-connection-end-point-spec/odu-term-and-adapter/accepted-payload-type/: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/pm-data-pac/: get: tags: - - "tapi-odu" - description: "returns tapi.odu.OduPayloadType" + - "tapi-oam" + summary: "returns tapi.oam.PmDataPac" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of meg" + description: "Id of oam-job" required: true type: "string" - name: "local-id" in: "path" - description: "Id of mep" + description: "Id of current-data" required: true type: "string" responses: 200: - description: "tapi.odu.OduPayloadType" + description: "tapi.oam.PmDataPac" schema: - $ref: "#/definitions/tapi.odu.OduPayloadType" + $ref: "#/definitions/tapi.oam.PmDataPac" 400: description: "Internal error" - /data/context/oam-context/meg={uuid}/mip={local-id}/: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/pm-data-pac/granularity-period/: get: tags: - "tapi-oam" - description: "returns tapi.oam.meg.Mip" + summary: "returns tapi.common.TimePeriod" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of meg" + description: "Id of oam-job" required: true type: "string" - name: "local-id" in: "path" - description: "Id of mip" + description: "Id of current-data" required: true type: "string" responses: 200: - description: "tapi.oam.meg.Mip" + description: "tapi.common.TimePeriod" schema: - $ref: "#/definitions/tapi.oam.meg.Mip" + $ref: "#/definitions/tapi.common.TimePeriod" 400: description: "Internal error" - /data/context/oam-context/meg={uuid}/mip={local-id}/name={value-name}/: - get: + /data/context/oam-context/oam-job={uuid}/name/: + post: tags: - "tapi-oam" - description: "returns tapi.common.NameAndValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of meg" + description: "Id of oam-job" required: true type: "string" - - name: "local-id" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-job={uuid}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" in: "path" - description: "Id of mip" + description: "Id of oam-job" required: true type: "string" - name: "value-name" @@ -4876,237 +5251,263 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/oam-context/meg={uuid}/mip={local-id}/odu-mip-spec/: - get: + put: tags: - - "tapi-odu" - description: "returns tapi.odu.OduMipSpec" + - "tapi-oam" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of meg" + description: "Id of oam-job" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of mip" + description: "Id of name" required: true type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" responses: - 200: - description: "tapi.odu.OduMipSpec" - schema: - $ref: "#/definitions/tapi.odu.OduMipSpec" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/oam-context/meg={uuid}/mip={local-id}/odu-mip-spec/odu-defect/: - get: + 204: + description: "Object modified" + delete: tags: - - "tapi-odu" - description: "returns tapi.odu.OduDefectPac" + - "tapi-oam" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of meg" + description: "Id of oam-job" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of mip" + description: "Id of name" required: true type: "string" responses: - 200: - description: "tapi.odu.OduDefectPac" - schema: - $ref: "#/definitions/tapi.odu.OduDefectPac" 400: description: "Internal error" - /data/context/oam-context/meg={uuid}/mip={local-id}/odu-mip-spec/odu-mip/: + 204: + description: "Object deleted" + /data/context/oam-context/oam-job={uuid}/oam-profile/: get: tags: - - "tapi-odu" - description: "returns tapi.odu.OduMipPac" + - "tapi-oam" + summary: "returns tapi.oam.OamProfileRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mip" + description: "Id of oam-job" required: true type: "string" responses: 200: - description: "tapi.odu.OduMipPac" + description: "tapi.oam.OamProfileRef" schema: - $ref: "#/definitions/tapi.odu.OduMipPac" + $ref: "#/definitions/tapi.oam.OamProfileRef" 400: description: "Internal error" - /data/context/oam-context/meg={uuid}/mip={local-id}/odu-mip-spec/odu-mip/deg-thr/: - get: + post: tags: - - "tapi-odu" - description: "returns tapi.odu.DegThr" + - "tapi-oam" + summary: "creates tapi.oam.OamProfileRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mip" + description: "Id of oam-job" required: true type: "string" + - in: "body" + name: "tapi.oam.OamProfileRef.body-param" + description: "tapi.oam.OamProfileRef to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamProfileRef" responses: - 200: - description: "tapi.odu.DegThr" - schema: - $ref: "#/definitions/tapi.odu.DegThr" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/oam-context/meg={uuid}/mip={local-id}/odu-mip-spec/odu-ncm/: - get: + 409: + description: "Object already exists" + put: tags: - - "tapi-odu" - description: "returns tapi.odu.OduNcmPac" + - "tapi-oam" + summary: "creates or updates tapi.oam.OamProfileRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mip" + description: "Id of oam-job" required: true type: "string" + - in: "body" + name: "tapi.oam.OamProfileRef.body-param" + description: "tapi.oam.OamProfileRef to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamProfileRef" responses: - 200: - description: "tapi.odu.OduNcmPac" - schema: - $ref: "#/definitions/tapi.odu.OduNcmPac" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/oam-context/meg={uuid}/mip={local-id}/odu-mip-spec/odu-pm/: - get: + 204: + description: "Object modified" + delete: tags: - - "tapi-odu" - description: "returns tapi.odu.OduPmPac" + - "tapi-oam" + summary: "removes tapi.oam.OamProfileRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mip" + description: "Id of oam-job" required: true type: "string" responses: - 200: - description: "tapi.odu.OduPmPac" - schema: - $ref: "#/definitions/tapi.odu.OduPmPac" 400: description: "Internal error" - /data/context/oam-context/meg={uuid}/mip={local-id}/odu-mip-spec/odu-pm/uas/: - get: + 204: + description: "Object deleted" + /data/context/oam-context/oam-job={uuid}/oam-service-point/: + post: tags: - - "tapi-odu" - description: "returns tapi.odu.UasChoice" + - "tapi-oam" + summary: "creates tapi.oam.OamServicePointRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mip" + description: "Id of oam-job" required: true type: "string" + - in: "body" + name: "tapi.oam.OamServicePointRef.body-param" + description: "tapi.oam.OamServicePointRef to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamServicePointRef" responses: - 200: - description: "tapi.odu.UasChoice" - schema: - $ref: "#/definitions/tapi.odu.UasChoice" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/oam-context/meg={uuid}/mip={local-id}/odu-mip-spec/odu-tcm/: + 409: + description: "Object already exists" + /data/context/oam-context/oam-job={uuid}/oam-service-point={oam-service-uuid},{oam-service-point-local-id}/: get: tags: - - "tapi-odu" - description: "returns tapi.odu.OduTcmMipPac" + - "tapi-oam" + summary: "returns tapi.oam.OamServicePointRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of meg" + description: "Id of oam-job" required: true type: "string" - - name: "local-id" + - name: "oam-service-uuid" in: "path" - description: "Id of mip" + description: "Id of oam-service-point" + required: true + type: "string" + - name: "oam-service-point-local-id" + in: "path" + description: "Id of oam-service-point" required: true type: "string" responses: 200: - description: "tapi.odu.OduTcmMipPac" + description: "tapi.oam.OamServicePointRef" schema: - $ref: "#/definitions/tapi.odu.OduTcmMipPac" + $ref: "#/definitions/tapi.oam.OamServicePointRef" 400: description: "Internal error" - /data/context/oam-context/meg={uuid}/name={value-name}/: - get: + put: tags: - "tapi-oam" - description: "returns tapi.common.NameAndValue" + summary: "creates or updates tapi.oam.OamServicePointRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of meg" + description: "Id of oam-job" required: true type: "string" - - name: "value-name" + - name: "oam-service-uuid" in: "path" - description: "Id of name" + description: "Id of oam-service-point" required: true type: "string" + - name: "oam-service-point-local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - in: "body" + name: "tapi.oam.OamServicePointRef.body-param" + description: "tapi.oam.OamServicePointRef to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamServicePointRef" responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/oam-context/oam-job/: - post: + 204: + description: "Object modified" + delete: tags: - "tapi-oam" - description: "creates tapi.oam.OamJob" + summary: "removes tapi.oam.OamServicePointRef" + description: "none" parameters: - - in: "body" - name: "tapi.oam.OamJob.body-param" - description: "tapi.oam.OamJob to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamJob" + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "oam-service-uuid" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - name: "oam-service-point-local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" responses: - 201: - description: "Object created" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-job={uuid}/: + 204: + description: "Object deleted" + /data/context/oam-context/oam-job={uuid}/schedule/: get: tags: - "tapi-oam" - description: "returns tapi.oam.OamJob" + summary: "returns tapi.common.TimeRange" + description: "none" parameters: - name: "uuid" in: "path" @@ -5115,15 +5516,16 @@ paths: type: "string" responses: 200: - description: "tapi.oam.OamJob" + description: "tapi.common.TimeRange" schema: - $ref: "#/definitions/tapi.oam.OamJob" + $ref: "#/definitions/tapi.common.TimeRange" 400: description: "Internal error" post: tags: - "tapi-oam" - description: "creates tapi.oam.OamJob" + summary: "creates tapi.common.TimeRange" + description: "none" parameters: - name: "uuid" in: "path" @@ -5131,11 +5533,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.oam.OamJob.body-param" - description: "tapi.oam.OamJob to be added to list" + name: "tapi.common.TimeRange.body-param" + description: "tapi.common.TimeRange to be added to list" required: false schema: - $ref: "#/definitions/tapi.oam.OamJob" + $ref: "#/definitions/tapi.common.TimeRange" responses: 201: description: "Object created" @@ -5146,7 +5548,8 @@ paths: put: tags: - "tapi-oam" - description: "creates or updates tapi.oam.OamJob" + summary: "creates or updates tapi.common.TimeRange" + description: "none" parameters: - name: "uuid" in: "path" @@ -5154,11 +5557,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.oam.OamJob.body-param" - description: "tapi.oam.OamJob to be added or updated" + name: "tapi.common.TimeRange.body-param" + description: "tapi.common.TimeRange to be added or updated" required: false schema: - $ref: "#/definitions/tapi.oam.OamJob" + $ref: "#/definitions/tapi.common.TimeRange" responses: 201: description: "Object created" @@ -5169,7 +5572,8 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.oam.OamJob" + summary: "removes tapi.common.TimeRange" + description: "none" parameters: - name: "uuid" in: "path" @@ -5181,23 +5585,19 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/name/: + /data/context/oam-context/oam-profile/: post: tags: - "tapi-oam" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.oam.OamProfile" + description: "none" parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.oam.OamProfile.body-param" + description: "tapi.oam.OamProfile to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.oam.OamProfile" responses: 201: description: "Object created" @@ -5205,42 +5605,77 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/oam-context/oam-job={uuid}/name={value-name}/: + /data/context/oam-context/oam-profile={uuid}/: get: tags: - "tapi-oam" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.oam.OamProfile" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of oam-profile" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.oam.OamProfile" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.oam.OamProfile" 400: description: "Internal error" - post: + put: tags: - "tapi-oam" - description: "creates tapi.common.NameAndValue" + summary: "creates or updates tapi.oam.OamProfile" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of oam-profile" required: true type: "string" - - name: "value-name" + - in: "body" + name: "tapi.oam.OamProfile.body-param" + description: "tapi.oam.OamProfile to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamProfile" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.OamProfile" + description: "none" + parameters: + - name: "uuid" in: "path" - description: "Id of name" + description: "Id of oam-profile" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-profile={uuid}/name/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" required: true type: "string" - in: "body" @@ -5256,14 +5691,43 @@ paths: description: "Internal error" 409: description: "Object already exists" + /data/context/oam-context/oam-profile={uuid}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" put: tags: - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of oam-profile" required: true type: "string" - name: "value-name" @@ -5287,11 +5751,14 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of oam-profile" required: true type: "string" - name: "value-name" @@ -5304,63 +5771,77 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/oam-profile/: - get: + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data/: + post: tags: - "tapi-oam" - description: "returns tapi.oam.OamProfileRef" + summary: "creates tapi.oam.PmThresholdData" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of oam-profile" required: true type: "string" + - in: "body" + name: "tapi.oam.PmThresholdData.body-param" + description: "tapi.oam.PmThresholdData to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.PmThresholdData" responses: - 200: - description: "tapi.oam.OamProfileRef" - schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/: + get: tags: - "tapi-oam" - description: "creates tapi.oam.OamProfileRef" + summary: "returns tapi.oam.PmThresholdData" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" required: true type: "string" - - in: "body" - name: "tapi.oam.OamProfileRef.body-param" - description: "tapi.oam.OamProfileRef to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" responses: - 201: - description: "Object created" + 200: + description: "tapi.oam.PmThresholdData" + schema: + $ref: "#/definitions/tapi.oam.PmThresholdData" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-oam" - description: "creates or updates tapi.oam.OamProfileRef" + summary: "creates or updates tapi.oam.PmThresholdData" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" required: true type: "string" - in: "body" - name: "tapi.oam.OamProfileRef.body-param" - description: "tapi.oam.OamProfileRef to be added or updated" + name: "tapi.oam.PmThresholdData.body-param" + description: "tapi.oam.PmThresholdData to be added or updated" required: false schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" + $ref: "#/definitions/tapi.oam.PmThresholdData" responses: 201: description: "Object created" @@ -5371,96 +5852,70 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.oam.OamProfileRef" + summary: "removes tapi.oam.PmThresholdData" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of oam-profile" required: true type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/oam-service-end-point/: - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamServiceEndPointRef" - parameters: - - name: "uuid" + - name: "local-id" in: "path" - description: "Id of oam-job" + description: "Id of pm-threshold-data" required: true type: "string" - - in: "body" - name: "tapi.oam.OamServiceEndPointRef.body-param" - description: "tapi.oam.OamServiceEndPointRef to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPointRef" responses: - 201: - description: "Object created" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-job={uuid}/oam-service-end-point={oam-service-uuid},{oam-service-end-point-local-id}/: + 204: + description: "Object deleted" + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/granularity-period/: get: tags: - "tapi-oam" - description: "returns tapi.oam.OamServiceEndPointRef" + summary: "returns tapi.common.TimePeriod" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "oam-service-uuid" - in: "path" - description: "Id of oam-service-end-point" + description: "Id of oam-profile" required: true type: "string" - - name: "oam-service-end-point-local-id" + - name: "local-id" in: "path" - description: "Id of oam-service-end-point" + description: "Id of pm-threshold-data" required: true type: "string" responses: 200: - description: "tapi.oam.OamServiceEndPointRef" + description: "tapi.common.TimePeriod" schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPointRef" + $ref: "#/definitions/tapi.common.TimePeriod" 400: description: "Internal error" post: tags: - "tapi-oam" - description: "creates tapi.oam.OamServiceEndPointRef" + summary: "creates tapi.common.TimePeriod" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "oam-service-uuid" - in: "path" - description: "Id of oam-service-end-point" + description: "Id of oam-profile" required: true type: "string" - - name: "oam-service-end-point-local-id" + - name: "local-id" in: "path" - description: "Id of oam-service-end-point" + description: "Id of pm-threshold-data" required: true type: "string" - in: "body" - name: "tapi.oam.OamServiceEndPointRef.body-param" - description: "tapi.oam.OamServiceEndPointRef to be added to list" + name: "tapi.common.TimePeriod.body-param" + description: "tapi.common.TimePeriod to be added to list" required: false schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPointRef" + $ref: "#/definitions/tapi.common.TimePeriod" responses: 201: description: "Object created" @@ -5471,29 +5926,25 @@ paths: put: tags: - "tapi-oam" - description: "creates or updates tapi.oam.OamServiceEndPointRef" + summary: "creates or updates tapi.common.TimePeriod" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "oam-service-uuid" - in: "path" - description: "Id of oam-service-end-point" + description: "Id of oam-profile" required: true type: "string" - - name: "oam-service-end-point-local-id" + - name: "local-id" in: "path" - description: "Id of oam-service-end-point" + description: "Id of pm-threshold-data" required: true type: "string" - in: "body" - name: "tapi.oam.OamServiceEndPointRef.body-param" - description: "tapi.oam.OamServiceEndPointRef to be added or updated" + name: "tapi.common.TimePeriod.body-param" + description: "tapi.common.TimePeriod to be added or updated" required: false schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPointRef" + $ref: "#/definitions/tapi.common.TimePeriod" responses: 201: description: "Object created" @@ -5504,21 +5955,17 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.oam.OamServiceEndPointRef" + summary: "removes tapi.common.TimePeriod" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "oam-service-uuid" - in: "path" - description: "Id of oam-service-end-point" + description: "Id of oam-profile" required: true type: "string" - - name: "oam-service-end-point-local-id" + - name: "local-id" in: "path" - description: "Id of oam-service-end-point" + description: "Id of pm-threshold-data" required: true type: "string" responses: @@ -5526,254 +5973,333 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/: - get: + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/name/: + post: tags: - "tapi-oam" - description: "returns tapi.oam.PmCurrentData" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of oam-profile" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" + description: "Id of pm-threshold-data" required: true type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" responses: - 200: - description: "tapi.oam.PmCurrentData" - schema: - $ref: "#/definitions/tapi.oam.PmCurrentData" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/elapsed-time/: + 409: + description: "Object already exists" + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/name={value-name}/: get: tags: - "tapi-oam" - description: "returns tapi.common.TimeInterval" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of oam-profile" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.common.TimeInterval" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.common.TimeInterval" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/elapsed-time/period={unit}/: - get: + put: tags: - "tapi-oam" - description: "returns tapi.common.TimePeriod" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of oam-profile" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" + description: "Id of pm-threshold-data" required: true type: "string" - - name: "unit" + - name: "value-name" in: "path" - description: "Id of period" + description: "Id of name" required: true type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" responses: - 200: - description: "tapi.common.TimePeriod" - schema: - $ref: "#/definitions/tapi.common.TimePeriod" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/granularity-period/: - get: - tags: + 204: + description: "Object modified" + delete: + tags: - "tapi-oam" - description: "returns tapi.common.TimePeriod" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of oam-profile" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" required: true type: "string" responses: - 200: - description: "tapi.common.TimePeriod" - schema: - $ref: "#/definitions/tapi.common.TimePeriod" 400: description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/name={value-name}/: - get: + 204: + description: "Object deleted" + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/threshold-parameter/: + post: tags: - "tapi-oam" - description: "returns tapi.common.NameAndValue" + summary: "creates tapi.oam.ThresholdParameter" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of oam-profile" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of pm-threshold-data" required: true type: "string" + - in: "body" + name: "tapi.oam.ThresholdParameter.body-param" + description: "tapi.oam.ThresholdParameter to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.ThresholdParameter" responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/: - get: + 409: + description: "Object already exists" + ? /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/threshold-parameter={pm-parameter-name},{threshold-location}/ + : get: tags: - "tapi-oam" - description: "returns tapi.oam.PmHistoryData" + summary: "returns tapi.oam.ThresholdParameter" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of oam-profile" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" required: true type: "string" - - name: "pm-history-data-local-id" + - name: "threshold-location" in: "path" - description: "Id of pm-history-data" + description: "Id of threshold-parameter" required: true type: "string" responses: 200: - description: "tapi.oam.PmHistoryData" + description: "tapi.oam.ThresholdParameter" schema: - $ref: "#/definitions/tapi.oam.PmHistoryData" + $ref: "#/definitions/tapi.oam.ThresholdParameter" 400: description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/granularity-period/ - : get: + put: tags: - "tapi-oam" - description: "returns tapi.common.TimePeriod" + summary: "creates or updates tapi.oam.ThresholdParameter" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of oam-profile" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" required: true type: "string" - - name: "pm-history-data-local-id" + - name: "threshold-location" in: "path" - description: "Id of pm-history-data" + description: "Id of threshold-parameter" required: true type: "string" + - in: "body" + name: "tapi.oam.ThresholdParameter.body-param" + description: "tapi.oam.ThresholdParameter to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.ThresholdParameter" responses: - 200: - description: "tapi.common.TimePeriod" - schema: - $ref: "#/definitions/tapi.common.TimePeriod" + 201: + description: "Object created" 400: description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/name={value-name}/ - : get: + 204: + description: "Object modified" + delete: tags: - "tapi-oam" - description: "returns tapi.common.NameAndValue" + summary: "removes tapi.oam.ThresholdParameter" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of oam-profile" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-current-data" + description: "Id of pm-threshold-data" required: true type: "string" - - name: "pm-history-data-local-id" + - name: "pm-parameter-name" in: "path" - description: "Id of pm-history-data" + description: "Id of threshold-parameter" required: true type: "string" - - name: "value-name" + - name: "threshold-location" in: "path" - description: "Id of name" + description: "Id of threshold-parameter" required: true type: "string" responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/oam-context/oam-job={uuid}/schedule/: - get: + 204: + description: "Object deleted" + ? /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/threshold-parameter={pm-parameter-name},{threshold-location}/pm-parameter-above-thrs/ + : get: tags: - "tapi-oam" - description: "returns tapi.common.TimeRange" + summary: "returns tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" required: true type: "string" responses: 200: - description: "tapi.common.TimeRange" + description: "tapi.oam.PmParameterValue" schema: - $ref: "#/definitions/tapi.common.TimeRange" + $ref: "#/definitions/tapi.oam.PmParameterValue" 400: description: "Internal error" post: tags: - "tapi-oam" - description: "creates tapi.common.TimeRange" + summary: "creates tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" required: true type: "string" - in: "body" - name: "tapi.common.TimeRange.body-param" - description: "tapi.common.TimeRange to be added to list" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.TimeRange" + $ref: "#/definitions/tapi.oam.PmParameterValue" responses: 201: description: "Object created" @@ -5784,19 +6310,35 @@ paths: put: tags: - "tapi-oam" - description: "creates or updates tapi.common.TimeRange" + summary: "creates or updates tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" required: true type: "string" - in: "body" - name: "tapi.common.TimeRange.body-param" - description: "tapi.common.TimeRange to be added or updated" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.TimeRange" + $ref: "#/definitions/tapi.oam.PmParameterValue" responses: 201: description: "Object created" @@ -5807,11 +6349,27 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.common.TimeRange" + summary: "removes tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-job" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" required: true type: "string" responses: @@ -5819,59 +6377,72 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-profile/: - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamProfile" - parameters: - - in: "body" - name: "tapi.oam.OamProfile.body-param" - description: "tapi.oam.OamProfile to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/: - get: + ? /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/threshold-parameter={pm-parameter-name},{threshold-location}/pm-parameter-below-thrs/ + : get: tags: - "tapi-oam" - description: "returns tapi.oam.OamProfile" + summary: "returns tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-profile" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" responses: 200: - description: "tapi.oam.OamProfile" + description: "tapi.oam.PmParameterValue" schema: - $ref: "#/definitions/tapi.oam.OamProfile" + $ref: "#/definitions/tapi.oam.PmParameterValue" 400: description: "Internal error" post: tags: - "tapi-oam" - description: "creates tapi.oam.OamProfile" + summary: "creates tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-profile" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" - in: "body" - name: "tapi.oam.OamProfile.body-param" - description: "tapi.oam.OamProfile to be added to list" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.oam.OamProfile" + $ref: "#/definitions/tapi.oam.PmParameterValue" responses: 201: description: "Object created" @@ -5882,19 +6453,35 @@ paths: put: tags: - "tapi-oam" - description: "creates or updates tapi.oam.OamProfile" + summary: "creates or updates tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-profile" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" - in: "body" - name: "tapi.oam.OamProfile.body-param" - description: "tapi.oam.OamProfile to be added or updated" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.oam.OamProfile" + $ref: "#/definitions/tapi.oam.PmParameterValue" responses: 201: description: "Object created" @@ -5905,86 +6492,100 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.oam.OamProfile" + summary: "removes tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-profile" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/name/: - post: + ? /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/threshold-parameter={pm-parameter-name},{threshold-location}/pm-parameter-clear-thrs/ + : get: tags: - "tapi-oam" - description: "creates tapi.common.NameAndValue" + summary: "returns tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-profile" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" + - name: "local-id" in: "path" - description: "Id of oam-profile" + description: "Id of pm-threshold-data" required: true type: "string" - - name: "value-name" + - name: "pm-parameter-name" in: "path" - description: "Id of name" + description: "Id of threshold-parameter" required: true type: "string" - responses: + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.oam.PmParameterValue" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.oam.PmParameterValue" 400: description: "Internal error" post: tags: - "tapi-oam" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-profile" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of name" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.oam.PmParameterValue" responses: 201: description: "Object created" @@ -5995,24 +6596,35 @@ paths: put: tags: - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" + summary: "creates or updates tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-profile" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of name" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.oam.PmParameterValue" responses: 201: description: "Object created" @@ -6023,16 +6635,27 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-profile" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of name" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" required: true type: "string" responses: @@ -6040,23 +6663,19 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-bin-data/: + /data/context/oam-context/oam-service/: post: tags: - "tapi-oam" - description: "creates tapi.oam.PmBinData" + summary: "creates tapi.oam.OamService" + description: "none" parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - in: "body" - name: "tapi.oam.PmBinData.body-param" - description: "tapi.oam.PmBinData to be added to list" + name: "tapi.oam.OamService.body-param" + description: "tapi.oam.OamService to be added to list" required: false schema: - $ref: "#/definitions/tapi.oam.PmBinData" + $ref: "#/definitions/tapi.oam.OamService" responses: 201: description: "Object created" @@ -6064,78 +6683,42 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/pm-bin-data={local-id}/: + /data/context/oam-context/oam-service={uuid}/: get: tags: - "tapi-oam" - description: "returns tapi.oam.PmBinData" + summary: "returns tapi.oam.OamService" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" + description: "Id of oam-service" required: true type: "string" responses: 200: - description: "tapi.oam.PmBinData" + description: "tapi.oam.OamService" schema: - $ref: "#/definitions/tapi.oam.PmBinData" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.PmBinData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - in: "body" - name: "tapi.oam.PmBinData.body-param" - description: "tapi.oam.PmBinData to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.PmBinData" - responses: - 201: - description: "Object created" + $ref: "#/definitions/tapi.oam.OamService" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-oam" - description: "creates or updates tapi.oam.PmBinData" + summary: "creates or updates tapi.oam.OamService" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" + description: "Id of oam-service" required: true type: "string" - in: "body" - name: "tapi.oam.PmBinData.body-param" - description: "tapi.oam.PmBinData to be added or updated" + name: "tapi.oam.OamService.body-param" + description: "tapi.oam.OamService to be added or updated" required: false schema: - $ref: "#/definitions/tapi.oam.PmBinData" + $ref: "#/definitions/tapi.oam.OamService" responses: 201: description: "Object created" @@ -6146,16 +6729,12 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.oam.PmBinData" + summary: "removes tapi.oam.OamService" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" + description: "Id of oam-service" required: true type: "string" responses: @@ -6163,50 +6742,45 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-bin-data={local-id}/granularity-period/: + /data/context/oam-context/oam-service={uuid}/meg/: get: tags: - "tapi-oam" - description: "returns tapi.common.TimePeriod" + summary: "returns tapi.oam.MegRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" + description: "Id of oam-service" required: true type: "string" responses: 200: - description: "tapi.common.TimePeriod" + description: "tapi.oam.MegRef" schema: - $ref: "#/definitions/tapi.common.TimePeriod" + $ref: "#/definitions/tapi.oam.MegRef" 400: description: "Internal error" + /data/context/oam-context/oam-service={uuid}/name/: post: tags: - "tapi-oam" - description: "creates tapi.common.TimePeriod" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" + description: "Id of oam-service" required: true type: "string" - in: "body" - name: "tapi.common.TimePeriod.body-param" - description: "tapi.common.TimePeriod to be added to list" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.TimePeriod" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -6214,27 +6788,56 @@ paths: description: "Internal error" 409: description: "Object already exists" + /data/context/oam-context/oam-service={uuid}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" put: tags: - "tapi-oam" - description: "creates or updates tapi.common.TimePeriod" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-service" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of pm-bin-data" + description: "Id of name" required: true type: "string" - in: "body" - name: "tapi.common.TimePeriod.body-param" - description: "tapi.common.TimePeriod to be added or updated" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.TimePeriod" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -6245,16 +6848,19 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.common.TimePeriod" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-service" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of pm-bin-data" + description: "Id of name" required: true type: "string" responses: @@ -6262,28 +6868,24 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-bin-data={local-id}/name/: + /data/context/oam-context/oam-service={uuid}/oam-service-point/: post: tags: - "tapi-oam" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.oam.OamServicePoint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" + description: "Id of oam-service" required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.oam.OamServicePoint.body-param" + description: "tapi.oam.OamServicePoint to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.oam.OamServicePoint" responses: 201: description: "Object created" @@ -6291,193 +6893,127 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/pm-bin-data={local-id}/name={value-name}/: + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/: get: tags: - "tapi-oam" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.oam.OamServicePoint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of oam-service-point" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.oam.OamServicePoint" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.oam.OamServicePoint" 400: description: "Internal error" - post: + put: tags: - "tapi-oam" - description: "creates tapi.common.NameAndValue" + summary: "creates or updates tapi.oam.OamServicePoint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of oam-service-point" required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.oam.OamServicePoint.body-param" + description: "tapi.oam.OamServicePoint to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.oam.OamServicePoint" responses: 201: description: "Object created" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + 204: + description: "Object modified" + delete: tags: - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" + summary: "removes tapi.oam.OamServicePoint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of oam-service-point" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" responses: - 201: - description: "Object created" 400: description: "Internal error" 204: - description: "Object modified" - delete: + description: "Object deleted" + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/connectivity-service-end-point/: + get: tags: - "tapi-oam" - description: "removes tapi.common.NameAndValue" + summary: "returns tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of oam-service-point" required: true type: "string" responses: + 200: + description: "tapi.connectivity.ConnectivityServiceEndPointRef" + schema: + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data/: post: tags: - "tapi-oam" - description: "creates tapi.oam.PmThresholdData" + summary: "creates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" required: true type: "string" - in: "body" - name: "tapi.oam.PmThresholdData.body-param" - description: "tapi.oam.PmThresholdData to be added to list" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ to list" required: false schema: - $ref: "#/definitions/tapi.oam.PmThresholdData" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.PmThresholdData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.PmThresholdData" - schema: - $ref: "#/definitions/tapi.oam.PmThresholdData" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.PmThresholdData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.oam.PmThresholdData.body-param" - description: "tapi.oam.PmThresholdData to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.PmThresholdData" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" responses: 201: description: "Object created" @@ -6488,24 +7024,26 @@ paths: put: tags: - "tapi-oam" - description: "creates or updates tapi.oam.PmThresholdData" + summary: "creates or updates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-service-point" required: true type: "string" - in: "body" - name: "tapi.oam.PmThresholdData.body-param" - description: "tapi.oam.PmThresholdData to be added or updated" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ or updated" required: false schema: - $ref: "#/definitions/tapi.oam.PmThresholdData" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" responses: 201: description: "Object created" @@ -6516,16 +7054,17 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.oam.PmThresholdData" + summary: "removes tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-service-point" required: true type: "string" responses: @@ -6533,119 +7072,71 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/granularity-period/: + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/mep/: get: tags: - "tapi-oam" - description: "returns tapi.common.TimePeriod" + summary: "returns tapi.oam.MepRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-service-point" required: true type: "string" responses: 200: - description: "tapi.common.TimePeriod" + description: "tapi.oam.MepRef" schema: - $ref: "#/definitions/tapi.common.TimePeriod" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.common.TimePeriod.body-param" - description: "tapi.common.TimePeriod to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.TimePeriod" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.common.TimePeriod.body-param" - description: "tapi.common.TimePeriod to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.TimePeriod" - responses: - 201: - description: "Object created" + $ref: "#/definitions/tapi.oam.MepRef" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/mip/: + get: tags: - "tapi-oam" - description: "removes tapi.common.TimePeriod" + summary: "returns tapi.oam.MipRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-service-point" required: true type: "string" responses: + 200: + description: "tapi.oam.MipRef" + schema: + $ref: "#/definitions/tapi.oam.MipRef" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/name/: + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/name/: post: tags: - "tapi-oam" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-service-point" required: true type: "string" - in: "body" @@ -6661,20 +7152,23 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/name={value-name}/: + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/name={value-name}/: get: tags: - "tapi-oam" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-service-point" required: true type: "string" - name: "value-name" @@ -6689,52 +7183,22 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-service-point" required: true type: "string" - name: "value-name" @@ -6758,16 +7222,19 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-profile" + description: "Id of oam-service" required: true type: "string" - name: "local-id" in: "path" - description: "Id of pm-threshold-data" + description: "Id of oam-service-point" required: true type: "string" - name: "value-name" @@ -6780,59 +7247,52 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-service/: - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamService" - parameters: - - in: "body" - name: "tapi.oam.OamService.body-param" - description: "tapi.oam.OamService to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-service={uuid}/: + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/service-interface-point/: get: tags: - "tapi-oam" - description: "returns tapi.oam.OamService" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" responses: 200: - description: "tapi.oam.OamService" + description: "tapi.common.ServiceInterfacePointRef" schema: - $ref: "#/definitions/tapi.oam.OamService" + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" 400: description: "Internal error" post: tags: - "tapi-oam" - description: "creates tapi.oam.OamService" + summary: "creates tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" - in: "body" - name: "tapi.oam.OamService.body-param" - description: "tapi.oam.OamService to be added to list" + name: "tapi.common.ServiceInterfacePointRef.body-param" + description: "tapi.common.ServiceInterfacePointRef to be added to list" required: false schema: - $ref: "#/definitions/tapi.oam.OamService" + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" responses: 201: description: "Object created" @@ -6843,19 +7303,25 @@ paths: put: tags: - "tapi-oam" - description: "creates or updates tapi.oam.OamService" + summary: "creates or updates tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" - in: "body" - name: "tapi.oam.OamService.body-param" - description: "tapi.oam.OamService to be added or updated" + name: "tapi.common.ServiceInterfacePointRef.body-param" + description: "tapi.common.ServiceInterfacePointRef to be added or updated" required: false schema: - $ref: "#/definitions/tapi.oam.OamService" + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" responses: 201: description: "Object created" @@ -6866,35 +7332,103 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.oam.OamService" + summary: "removes tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/end-point/: + /data/context/path-computation-context/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" + parameters: [] + responses: + 200: + description: "tapi.path.computation.PathComputationContext" + schema: + $ref: "#/definitions/tapi.path.computation.PathComputationContext" + 400: + description: "Internal error" post: tags: - - "tapi-oam" - description: "creates tapi.oam.OamServiceEndPoint" + - "tapi-path-computation" + summary: "creates tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" + parameters: + - in: "body" + name: "tapi.path.computation.PathComputationContext.body-param" + description: "tapi.path.computation.PathComputationContext to be added to\ + \ list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.PathComputationContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" + parameters: + - in: "body" + name: "tapi.path.computation.PathComputationContext.body-param" + description: "tapi.path.computation.PathComputationContext to be added or\ + \ updated" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.PathComputationContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.path.computation.PathComputationService" + description: "none" parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - in: "body" - name: "tapi.oam.OamServiceEndPoint.body-param" - description: "tapi.oam.OamServiceEndPoint to be added to list" + name: "tapi.path.computation.PathComputationService.body-param" + description: "tapi.path.computation.PathComputationService to be added to\ + \ list" required: false schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" + $ref: "#/definitions/tapi.path.computation.PathComputationService" responses: 201: description: "Object created" @@ -6902,50 +7436,84 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/: + /data/context/path-computation-context/path-comp-service={uuid}/: get: tags: - - "tapi-oam" - description: "returns tapi.oam.OamServiceEndPoint" + - "tapi-path-computation" + summary: "returns tapi.path.computation.PathComputationService" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + responses: + 200: + description: "tapi.path.computation.PathComputationService" + schema: + $ref: "#/definitions/tapi.path.computation.PathComputationService" + 400: + description: "Internal error" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.path.computation.PathComputationService" + description: "none" + parameters: + - name: "uuid" in: "path" - description: "Id of end-point" + description: "Id of path-comp-service" required: true type: "string" + - in: "body" + name: "tapi.path.computation.PathComputationService.body-param" + description: "tapi.path.computation.PathComputationService to be added or\ + \ updated" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.PathComputationService" responses: - 200: - description: "tapi.oam.OamServiceEndPoint" - schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" + 201: + description: "Object created" 400: description: "Internal error" - post: + 204: + description: "Object modified" + delete: tags: - - "tapi-oam" - description: "creates tapi.oam.OamServiceEndPoint" + - "tapi-path-computation" + summary: "removes tapi.path.computation.PathComputationService" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/end-point/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.path.computation.PathServiceEndPoint" + description: "none" + parameters: + - name: "uuid" in: "path" - description: "Id of end-point" + description: "Id of path-comp-service" required: true type: "string" - in: "body" - name: "tapi.oam.OamServiceEndPoint.body-param" - description: "tapi.oam.OamServiceEndPoint to be added to list" + name: "tapi.path.computation.PathServiceEndPoint.body-param" + description: "tapi.path.computation.PathServiceEndPoint to be added to list" required: false schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" + $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" responses: 201: description: "Object created" @@ -6953,14 +7521,39 @@ paths: description: "Internal error" 409: description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.path.computation.PathServiceEndPoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.path.computation.PathServiceEndPoint" + schema: + $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + 400: + description: "Internal error" put: tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamServiceEndPoint" + - "tapi-path-computation" + summary: "creates or updates tapi.path.computation.PathServiceEndPoint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" - name: "local-id" @@ -6969,11 +7562,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.oam.OamServiceEndPoint.body-param" - description: "tapi.oam.OamServiceEndPoint to be added or updated" + name: "tapi.path.computation.PathServiceEndPoint.body-param" + description: "tapi.path.computation.PathServiceEndPoint to be added or updated" required: false schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" + $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" responses: 201: description: "Object created" @@ -6983,12 +7576,13 @@ paths: description: "Object modified" delete: tags: - - "tapi-oam" - description: "removes tapi.oam.OamServiceEndPoint" + - "tapi-path-computation" + summary: "removes tapi.path.computation.PathServiceEndPoint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" - name: "local-id" @@ -7001,15 +7595,16 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/connectivity-service-end-point/: + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/: get: tags: - - "tapi-oam" - description: "returns tapi.connectivity.ConnectivityServiceEndPointRef" + - "tapi-path-computation" + summary: "returns tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" - name: "local-id" @@ -7019,19 +7614,20 @@ paths: type: "string" responses: 200: - description: "tapi.connectivity.ConnectivityServiceEndPointRef" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" post: tags: - - "tapi-oam" - description: "creates tapi.connectivity.ConnectivityServiceEndPointRef" + - "tapi-path-computation" + summary: "creates tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" - name: "local-id" @@ -7040,12 +7636,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" - description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ - \ to list" + name: "tapi.common.Capacity.body-param" + description: "tapi.common.Capacity to be added to list" required: false schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" + $ref: "#/definitions/tapi.common.Capacity" responses: 201: description: "Object created" @@ -7055,12 +7650,13 @@ paths: description: "Object already exists" put: tags: - - "tapi-oam" - description: "creates or updates tapi.connectivity.ConnectivityServiceEndPointRef" + - "tapi-path-computation" + summary: "creates or updates tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" - name: "local-id" @@ -7069,12 +7665,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" - description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ - \ or updated" + name: "tapi.common.Capacity.body-param" + description: "tapi.common.Capacity to be added or updated" required: false schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" + $ref: "#/definitions/tapi.common.Capacity" responses: 201: description: "Object created" @@ -7084,12 +7679,13 @@ paths: description: "Object modified" delete: tags: - - "tapi-oam" - description: "removes tapi.connectivity.ConnectivityServiceEndPointRef" + - "tapi-path-computation" + summary: "removes tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" - name: "local-id" @@ -7102,15 +7698,17 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/mep/: + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/total-size/: get: tags: - - "tapi-oam" - description: "returns tapi.oam.MepRef" + - "tapi-path-computation" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" - name: "local-id" @@ -7120,20 +7718,21 @@ paths: type: "string" responses: 200: - description: "tapi.oam.MepRef" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.oam.MepRef" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/mip/: - get: + post: tags: - - "tapi-oam" - description: "returns tapi.oam.MipRef" + - "tapi-path-computation" + summary: "creates tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" - name: "local-id" @@ -7141,22 +7740,29 @@ paths: description: "Id of end-point" required: true type: "string" + - in: "body" + name: "tapi.common.CapacityValue.body-param" + description: "tapi.common.CapacityValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.CapacityValue" responses: - 200: - description: "tapi.oam.MipRef" - schema: - $ref: "#/definitions/tapi.oam.MipRef" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/name/: - post: + 409: + description: "Object already exists" + put: tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" + - "tapi-path-computation" + summary: "creates or updates tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" - name: "local-id" @@ -7165,27 +7771,28 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.common.CapacityValue.body-param" + description: "tapi.common.CapacityValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.common.CapacityValue" responses: 201: description: "Object created" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/name={value-name}/: - get: + 204: + description: "Object modified" + delete: tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" + - "tapi-path-computation" + summary: "removes tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" - name: "local-id" @@ -7193,26 +7800,23 @@ paths: description: "Id of end-point" required: true type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/name/: post: tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" + - "tapi-path-computation" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" - name: "local-id" @@ -7220,11 +7824,6 @@ paths: description: "Id of end-point" required: true type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - in: "body" name: "tapi.common.NameAndValue.body-param" description: "tapi.common.NameAndValue to be added to list" @@ -7238,14 +7837,48 @@ paths: description: "Internal error" 409: description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/name={value-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" put: tags: - - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" + - "tapi-path-computation" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" - name: "local-id" @@ -7273,12 +7906,15 @@ paths: description: "Object modified" delete: tags: - - "tapi-oam" - description: "removes tapi.common.NameAndValue" + - "tapi-path-computation" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" - name: "local-id" @@ -7296,15 +7932,16 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/service-interface-point/: + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/service-interface-point/: get: tags: - - "tapi-oam" - description: "returns tapi.common.ServiceInterfacePointRef" + - "tapi-path-computation" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" - name: "local-id" @@ -7321,12 +7958,13 @@ paths: description: "Internal error" post: tags: - - "tapi-oam" - description: "creates tapi.common.ServiceInterfacePointRef" + - "tapi-path-computation" + summary: "creates tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" - name: "local-id" @@ -7349,12 +7987,13 @@ paths: description: "Object already exists" put: tags: - - "tapi-oam" - description: "creates or updates tapi.common.ServiceInterfacePointRef" + - "tapi-path-computation" + summary: "creates or updates tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" - name: "local-id" @@ -7377,12 +8016,13 @@ paths: description: "Object modified" delete: tags: - - "tapi-oam" - description: "removes tapi.common.ServiceInterfacePointRef" + - "tapi-path-computation" + summary: "removes tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" - name: "local-id" @@ -7395,33 +8035,18 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/meg/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.MegRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.MegRef" - schema: - $ref: "#/definitions/tapi.oam.MegRef" - 400: - description: "Internal error" - /data/context/oam-context/oam-service={uuid}/name/: + /data/context/path-computation-context/path-comp-service={uuid}/name/: post: tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" + - "tapi-path-computation" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" - in: "body" @@ -7437,15 +8062,18 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/oam-context/oam-service={uuid}/name={value-name}/: + /data/context/path-computation-context/path-comp-service={uuid}/name={value-name}/: get: tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" + - "tapi-path-computation" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" - name: "value-name" @@ -7460,42 +8088,17 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" put: tags: - - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" + - "tapi-path-computation" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" - name: "value-name" @@ -7518,12 +8121,15 @@ paths: description: "Object modified" delete: tags: - - "tapi-oam" - description: "removes tapi.common.NameAndValue" + - "tapi-path-computation" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" - name: "value-name" @@ -7536,40 +8142,42 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/oam-profile/: + /data/context/path-computation-context/path-comp-service={uuid}/objective-function/: get: tags: - - "tapi-oam" - description: "returns tapi.oam.OamProfileRef" + - "tapi-path-computation" + summary: "returns tapi.path.computation.PathObjectiveFunction" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" responses: 200: - description: "tapi.oam.OamProfileRef" + description: "tapi.path.computation.PathObjectiveFunction" schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" + $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" 400: description: "Internal error" post: tags: - - "tapi-oam" - description: "creates tapi.oam.OamProfileRef" + - "tapi-path-computation" + summary: "creates tapi.path.computation.PathObjectiveFunction" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" - in: "body" - name: "tapi.oam.OamProfileRef.body-param" - description: "tapi.oam.OamProfileRef to be added to list" + name: "tapi.path.computation.PathObjectiveFunction.body-param" + description: "tapi.path.computation.PathObjectiveFunction to be added to list" required: false schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" + $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" responses: 201: description: "Object created" @@ -7579,20 +8187,21 @@ paths: description: "Object already exists" put: tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamProfileRef" + - "tapi-path-computation" + summary: "creates or updates tapi.path.computation.PathObjectiveFunction" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" - in: "body" - name: "tapi.oam.OamProfileRef.body-param" - description: "tapi.oam.OamProfileRef to be added or updated" + name: "tapi.path.computation.PathObjectiveFunction.body-param" + description: "tapi.path.computation.PathObjectiveFunction to be added or updated" required: false schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" + $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" responses: 201: description: "Object created" @@ -7602,12 +8211,13 @@ paths: description: "Object modified" delete: tags: - - "tapi-oam" - description: "removes tapi.oam.OamProfileRef" + - "tapi-path-computation" + summary: "removes tapi.path.computation.PathObjectiveFunction" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" responses: @@ -7615,31 +8225,26 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathComputationContext" - parameters: [] - responses: - 200: - description: "tapi.path.computation.PathComputationContext" - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationContext" - 400: - description: "Internal error" + /data/context/path-computation-context/path-comp-service={uuid}/objective-function/name/: post: tags: - "tapi-path-computation" - description: "creates tapi.path.computation.PathComputationContext" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" - in: "body" - name: "tapi.path.computation.PathComputationContext.body-param" - description: "tapi.path.computation.PathComputationContext to be added to\ - \ list" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.path.computation.PathComputationContext" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -7647,60 +8252,92 @@ paths: description: "Internal error" 409: description: "Object already exists" - put: + /data/context/path-computation-context/path-comp-service={uuid}/objective-function/name={value-name}/: + get: tags: - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathComputationContext" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - - in: "body" - name: "tapi.path.computation.PathComputationContext.body-param" - description: "tapi.path.computation.PathComputationContext to be added or\ - \ updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.PathComputationContext" - parameters: [] + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service/: - post: + put: tags: - "tapi-path-computation" - description: "creates tapi.path.computation.PathComputationService" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" - in: "body" - name: "tapi.path.computation.PathComputationService.body-param" - description: "tapi.path.computation.PathComputationService to be added to\ - \ list" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.path.computation.PathComputationService" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/: - get: + 204: + description: "Object modified" + delete: tags: - "tapi-path-computation" - description: "returns tapi.path.computation.PathComputationService" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.path.computation.PathOptimizationConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -7709,15 +8346,16 @@ paths: type: "string" responses: 200: - description: "tapi.path.computation.PathComputationService" + description: "tapi.path.computation.PathOptimizationConstraint" schema: - $ref: "#/definitions/tapi.path.computation.PathComputationService" + $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" 400: description: "Internal error" post: tags: - "tapi-path-computation" - description: "creates tapi.path.computation.PathComputationService" + summary: "creates tapi.path.computation.PathOptimizationConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -7725,12 +8363,12 @@ paths: required: true type: "string" - in: "body" - name: "tapi.path.computation.PathComputationService.body-param" - description: "tapi.path.computation.PathComputationService to be added to\ - \ list" + name: "tapi.path.computation.PathOptimizationConstraint.body-param" + description: "tapi.path.computation.PathOptimizationConstraint to be added\ + \ to list" required: false schema: - $ref: "#/definitions/tapi.path.computation.PathComputationService" + $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" responses: 201: description: "Object created" @@ -7741,7 +8379,8 @@ paths: put: tags: - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathComputationService" + summary: "creates or updates tapi.path.computation.PathOptimizationConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -7749,12 +8388,12 @@ paths: required: true type: "string" - in: "body" - name: "tapi.path.computation.PathComputationService.body-param" - description: "tapi.path.computation.PathComputationService to be added or\ - \ updated" + name: "tapi.path.computation.PathOptimizationConstraint.body-param" + description: "tapi.path.computation.PathOptimizationConstraint to be added\ + \ or updated" required: false schema: - $ref: "#/definitions/tapi.path.computation.PathComputationService" + $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" responses: 201: description: "Object created" @@ -7765,7 +8404,8 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.path.computation.PathComputationService" + summary: "removes tapi.path.computation.PathOptimizationConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -7777,11 +8417,14 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point/: + /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name/: post: tags: - "tapi-path-computation" - description: "creates tapi.path.computation.PathServiceEndPoint" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -7789,11 +8432,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.path.computation.PathServiceEndPoint.body-param" - description: "tapi.path.computation.PathServiceEndPoint to be added to list" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -7801,149 +8444,146 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/: + /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name={value-name}/: get: tags: - "tapi-path-computation" - description: "returns tapi.path.computation.PathServiceEndPoint" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of end-point" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.path.computation.PathServiceEndPoint" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: + put: tags: - "tapi-path-computation" - description: "creates tapi.path.computation.PathServiceEndPoint" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of end-point" + description: "Id of name" required: true type: "string" - in: "body" - name: "tapi.path.computation.PathServiceEndPoint.body-param" - description: "tapi.path.computation.PathServiceEndPoint to be added to list" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + 204: + description: "Object modified" + delete: tags: - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathServiceEndPoint" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of end-point" + description: "Id of name" required: true type: "string" - - in: "body" - name: "tapi.path.computation.PathServiceEndPoint.body-param" - description: "tapi.path.computation.PathServiceEndPoint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" responses: - 201: - description: "Object created" 400: description: "Internal error" 204: - description: "Object modified" - delete: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/path={path-uuid}/: + get: tags: - "tapi-path-computation" - description: "removes tapi.path.computation.PathServiceEndPoint" + summary: "returns tapi.path.computation.PathRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "path-uuid" in: "path" - description: "Id of end-point" + description: "Id of path" required: true type: "string" responses: + 200: + description: "tapi.path.computation.PathRef" + schema: + $ref: "#/definitions/tapi.path.computation.PathRef" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/: + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/: get: tags: - "tapi-path-computation" - description: "returns tapi.common.Capacity" + summary: "returns tapi.path.computation.RoutingConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" responses: 200: - description: "tapi.common.Capacity" + description: "tapi.path.computation.RoutingConstraint" schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" 400: description: "Internal error" post: tags: - "tapi-path-computation" - description: "creates tapi.common.Capacity" + summary: "creates tapi.path.computation.RoutingConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - in: "body" - name: "tapi.common.Capacity.body-param" - description: "tapi.common.Capacity to be added to list" + name: "tapi.path.computation.RoutingConstraint.body-param" + description: "tapi.path.computation.RoutingConstraint to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" responses: 201: description: "Object created" @@ -7954,24 +8594,20 @@ paths: put: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.Capacity" + summary: "creates or updates tapi.path.computation.RoutingConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - in: "body" - name: "tapi.common.Capacity.body-param" - description: "tapi.common.Capacity to be added or updated" + name: "tapi.path.computation.RoutingConstraint.body-param" + description: "tapi.path.computation.RoutingConstraint to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" responses: 201: description: "Object created" @@ -7982,95 +8618,93 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.common.Capacity" + summary: "removes tapi.path.computation.RoutingConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/: - get: + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic/: + post: tags: - "tapi-path-computation" - description: "returns tapi.common.BandwidthProfile" + summary: "creates tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" + - in: "body" + name: "tapi.topology.CostCharacteristic.body-param" + description: "tapi.topology.CostCharacteristic to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic={cost-name}/: + get: tags: - "tapi-path-computation" - description: "creates tapi.common.BandwidthProfile" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "cost-name" in: "path" - description: "Id of end-point" + description: "Id of cost-characteristic" required: true type: "string" - - in: "body" - name: "tapi.common.BandwidthProfile.body-param" - description: "tapi.common.BandwidthProfile to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" responses: - 201: - description: "Object created" + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.BandwidthProfile" + summary: "creates or updates tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "cost-name" in: "path" - description: "Id of end-point" + description: "Id of cost-characteristic" required: true type: "string" - in: "body" - name: "tapi.common.BandwidthProfile.body-param" - description: "tapi.common.BandwidthProfile to be added or updated" + name: "tapi.topology.CostCharacteristic.body-param" + description: "tapi.topology.CostCharacteristic to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.topology.CostCharacteristic" responses: 201: description: "Object created" @@ -8081,16 +8715,18 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.common.BandwidthProfile" + summary: "removes tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "cost-name" in: "path" - description: "Id of end-point" + description: "Id of cost-characteristic" required: true type: "string" responses: @@ -8098,78 +8734,80 @@ paths: description: "Internal error" 204: description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-burst-size/ - : get: + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/latency-characteristic/: + post: tags: - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" + summary: "creates tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" + - in: "body" + name: "tapi.topology.LatencyCharacteristic.body-param" + description: "tapi.topology.LatencyCharacteristic to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + ? /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/ + : get: tags: - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "traffic-property-name" in: "path" - description: "Id of end-point" + description: "Id of latency-characteristic" required: true type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "traffic-property-name" in: "path" - description: "Id of end-point" + description: "Id of latency-characteristic" required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.topology.LatencyCharacteristic.body-param" + description: "tapi.topology.LatencyCharacteristic to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" responses: 201: description: "Object created" @@ -8180,16 +8818,18 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "traffic-property-name" in: "path" - description: "Id of end-point" + description: "Id of latency-characteristic" required: true type: "string" responses: @@ -8197,78 +8837,77 @@ paths: description: "Internal error" 204: description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-information-rate/ - : get: + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/risk-diversity-characteristic/: + post: tags: - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" + summary: "creates tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" + - in: "body" + name: "tapi.topology.RiskCharacteristic.body-param" + description: "tapi.topology.RiskCharacteristic to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + ? /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/ + : get: tags: - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" + summary: "returns tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "risk-characteristic-name" in: "path" - description: "Id of end-point" + description: "Id of risk-diversity-characteristic" required: true type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.topology.RiskCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "risk-characteristic-name" in: "path" - description: "Id of end-point" + description: "Id of risk-diversity-characteristic" required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.topology.RiskCharacteristic.body-param" + description: "tapi.topology.RiskCharacteristic to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.RiskCharacteristic" responses: 201: description: "Object created" @@ -8279,16 +8918,17 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "risk-characteristic-name" in: "path" - description: "Id of end-point" + description: "Id of risk-diversity-characteristic" required: true type: "string" responses: @@ -8296,33 +8936,37 @@ paths: description: "Internal error" 204: description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-burst-size/ - : get: + /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/: + post: tags: - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" + summary: "creates tapi.path.computation.TopologyConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" + - in: "body" + name: "tapi.path.computation.TopologyConstraint.body-param" + description: "tapi.path.computation.TopologyConstraint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint={local-id}/: + get: tags: - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" + summary: "returns tapi.path.computation.TopologyConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -8331,26 +8975,21 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of topology-constraint" required: true type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.path.computation.TopologyConstraint" + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.path.computation.TopologyConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -8359,15 +8998,15 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of topology-constraint" required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.path.computation.TopologyConstraint.body-param" + description: "tapi.path.computation.TopologyConstraint to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" responses: 201: description: "Object created" @@ -8378,7 +9017,8 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.path.computation.TopologyConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -8387,7 +9027,7 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of topology-constraint" required: true type: "string" responses: @@ -8395,11 +9035,14 @@ paths: description: "Internal error" 204: description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-information-rate/ - : get: + /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint={local-id}/name/: + post: tags: - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -8408,20 +9051,30 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of topology-constraint" required: true type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint={local-id}/name={value-name}/: + get: tags: - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -8430,26 +9083,28 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" required: true type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -8458,15 +9113,20 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -8477,7 +9137,10 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -8486,7 +9149,12 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" required: true type: "string" responses: @@ -8494,188 +9162,186 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/total-size/: + /data/context/path-computation-context/path={uuid}/: get: tags: - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.path.computation.Path" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" + description: "Id of path" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.path.computation.Path" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.path.computation.Path" 400: description: "Internal error" - post: + /data/context/path-computation-context/path={uuid}/link={topology-uuid},{link-uuid}/: + get: tags: - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" + summary: "returns tapi.topology.LinkRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of path" required: true type: "string" - - name: "local-id" + - name: "topology-uuid" in: "path" - description: "Id of end-point" + description: "Id of link" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" required: true type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.topology.LinkRef" + schema: + $ref: "#/definitions/tapi.topology.LinkRef" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + /data/context/path-computation-context/path={uuid}/name={value-name}/: + get: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of path" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of end-point" + description: "Id of name" required: true type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + /data/context/path-computation-context/path={uuid}/routing-constraint/: + get: tags: - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" + summary: "returns tapi.path.computation.RoutingConstraint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" + description: "Id of path" required: true type: "string" responses: + 200: + description: "tapi.path.computation.RoutingConstraint" + schema: + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/name/: - post: + /data/context/path-computation-context/path={uuid}/routing-constraint/cost-characteristic={cost-name}/: + get: tags: - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of path" required: true type: "string" - - name: "local-id" + - name: "cost-name" in: "path" - description: "Id of end-point" + description: "Id of cost-characteristic" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/name={value-name}/: + /data/context/path-computation-context/path={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/: get: tags: - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" + description: "Id of path" required: true type: "string" - - name: "value-name" + - name: "traffic-property-name" in: "path" - description: "Id of name" + description: "Id of latency-characteristic" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.topology.LatencyCharacteristic" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" - post: + /data/context/path-computation-context/path={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/: + get: tags: - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" + summary: "returns tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" + description: "Id of path" required: true type: "string" - - name: "value-name" + - name: "risk-characteristic-name" in: "path" - description: "Id of name" + description: "Id of risk-diversity-characteristic" required: true type: "string" + responses: + 200: + description: "tapi.topology.RiskCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" + 400: + description: "Internal error" + /data/context/service-interface-point/: + post: + tags: + - "tapi-common" + summary: "creates tapi.common.ServiceInterfacePoint" + description: "none" + parameters: - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.common.ServiceInterfacePoint.body-param" + description: "tapi.common.ServiceInterfacePoint to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" responses: 201: description: "Object created" @@ -8683,32 +9349,42 @@ paths: description: "Internal error" 409: description: "Object already exists" - put: + /data/context/service-interface-point={uuid}/: + get: tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" + - "tapi-common" + summary: "returns tapi.common.ServiceInterfacePoint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" + description: "Id of service-interface-point" required: true type: "string" - - name: "value-name" + responses: + 200: + description: "tapi.common.ServiceInterfacePoint" + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + 400: + description: "Internal error" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.ServiceInterfacePoint" + description: "none" + parameters: + - name: "uuid" in: "path" - description: "Id of name" + description: "Id of service-interface-point" required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" + name: "tapi.common.ServiceInterfacePoint.body-param" + description: "tapi.common.ServiceInterfacePoint to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" responses: 201: description: "Object created" @@ -8718,22 +9394,13 @@ paths: description: "Object modified" delete: tags: - - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" + - "tapi-common" + summary: "removes tapi.common.ServiceInterfacePoint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of service-interface-point" required: true type: "string" responses: @@ -8741,38 +9408,57 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/service-interface-point/: + /data/context/service-interface-point={uuid}/available-capacity/: get: tags: - - "tapi-path-computation" - description: "returns tapi.common.ServiceInterfacePointRef" + - "tapi-common" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of service-interface-point" required: true type: "string" - - name: "local-id" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/service-interface-point={uuid}/available-capacity/total-size/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" in: "path" - description: "Id of end-point" + description: "Id of service-interface-point" required: true type: "string" responses: 200: - description: "tapi.common.ServiceInterfacePointRef" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/name/: + /data/context/service-interface-point={uuid}/name/: post: tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" + - "tapi-common" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of service-interface-point" required: true type: "string" - in: "body" @@ -8788,15 +9474,18 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/name={value-name}/: + /data/context/service-interface-point={uuid}/name={value-name}/: get: tags: - - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" + - "tapi-common" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of service-interface-point" required: true type: "string" - name: "value-name" @@ -8811,42 +9500,17 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" put: tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" + - "tapi-common" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of service-interface-point" required: true type: "string" - name: "value-name" @@ -8869,12 +9533,15 @@ paths: description: "Object modified" delete: tags: - - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" + - "tapi-common" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of service-interface-point" required: true type: "string" - name: "value-name" @@ -8887,40 +9554,72 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/objective-function/: + /data/context/service-interface-point={uuid}/total-potential-capacity/: get: tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathObjectiveFunction" + - "tapi-common" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of service-interface-point" required: true type: "string" responses: 200: - description: "tapi.path.computation.PathObjectiveFunction" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - post: + /data/context/service-interface-point={uuid}/total-potential-capacity/total-size/: + get: tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathObjectiveFunction" + - "tapi-common" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of service-interface-point" required: true type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: [] + responses: + 200: + description: "tapi.topology.TopologyContext" + schema: + $ref: "#/definitions/tapi.topology.TopologyContext" + 400: + description: "Internal error" + post: + tags: + - "tapi-topology" + summary: "creates tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: - in: "body" - name: "tapi.path.computation.PathObjectiveFunction.body-param" - description: "tapi.path.computation.PathObjectiveFunction to be added to list" + name: "tapi.topology.context.TopologyContext.body-param" + description: "tapi.topology.TopologyContext to be added to list" required: false schema: - $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" + $ref: "#/definitions/tapi.topology.TopologyContext" responses: 201: description: "Object created" @@ -8930,20 +9629,16 @@ paths: description: "Object already exists" put: tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathObjectiveFunction" + - "tapi-topology" + summary: "creates or updates tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - in: "body" - name: "tapi.path.computation.PathObjectiveFunction.body-param" - description: "tapi.path.computation.PathObjectiveFunction to be added or updated" + name: "tapi.topology.context.TopologyContext.body-param" + description: "tapi.topology.TopologyContext to be added or updated" required: false schema: - $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" + $ref: "#/definitions/tapi.topology.TopologyContext" responses: 201: description: "Object created" @@ -8952,3291 +9647,187 @@ paths: 204: description: "Object modified" delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.PathObjectiveFunction" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/objective-function/name/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/objective-function/name={value-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathOptimizationConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathOptimizationConstraint" - schema: - $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathOptimizationConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathOptimizationConstraint.body-param" - description: "tapi.path.computation.PathOptimizationConstraint to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathOptimizationConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathOptimizationConstraint.body-param" - description: "tapi.path.computation.PathOptimizationConstraint to be added\ - \ or updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.PathOptimizationConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name={value-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/path={path-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "path-uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.RoutingConstraint" - schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.RoutingConstraint.body-param" - description: "tapi.path.computation.RoutingConstraint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.RoutingConstraint.body-param" - description: "tapi.path.computation.RoutingConstraint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/latency-characteristic/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - ? /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/ - : get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/risk-diversity-characteristic/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - ? /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/ - : get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.TopologyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.TopologyConstraint" - schema: - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.TopologyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.TopologyConstraint.body-param" - description: "tapi.path.computation.TopologyConstraint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.TopologyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.TopologyConstraint.body-param" - description: "tapi.path.computation.TopologyConstraint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.TopologyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/avoid-topology={topology-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of avoid-topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/exclude-link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LinkRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of exclude-link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of exclude-link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/exclude-node={topology-uuid},{node-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.NodeRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of exclude-node" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of exclude-node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/exclude-path={path-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "path-uuid" - in: "path" - description: "Id of exclude-path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LinkRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of include-link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-node={topology-uuid},{node-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.NodeRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-node" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of include-node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-path={path-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "path-uuid" - in: "path" - description: "Id of include-path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-topology={topology-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.Path" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.Path" - schema: - $ref: "#/definitions/tapi.path.computation.Path" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LinkRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/name={value-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/routing-constraint/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.RoutingConstraint" - schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/routing-constraint/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - /data/context/service-interface-point/: - post: - tags: - - "tapi-common" - description: "creates tapi.common.ServiceInterfacePoint" - parameters: - - in: "body" - name: "tapi.common.ServiceInterfacePoint.body-param" - description: "tapi.common.ServiceInterfacePoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/service-interface-point={uuid}/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.ServiceInterfacePoint" - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.ServiceInterfacePoint.body-param" - description: "tapi.common.ServiceInterfacePoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.ServiceInterfacePoint.body-param" - description: "tapi.common.ServiceInterfacePoint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/service-interface-point={uuid}/available-capacity/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/committed-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/total-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/name/: - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/service-interface-point={uuid}/name={value-name}/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/service-interface-point={uuid}/total-potential-capacity/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/total-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.TopologyContext" - parameters: [] - responses: - 200: - description: "tapi.topology.TopologyContext" - schema: - $ref: "#/definitions/tapi.topology.TopologyContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-topology" - description: "creates tapi.topology.TopologyContext" - parameters: - - in: "body" - name: "tapi.topology.context.TopologyContext.body-param" - description: "tapi.topology.TopologyContext to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.TopologyContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-topology" - description: "creates or updates tapi.topology.TopologyContext" - parameters: - - in: "body" - name: "tapi.topology.context.TopologyContext.body-param" - description: "tapi.topology.TopologyContext to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.TopologyContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-topology" - description: "removes tapi.topology.TopologyContext" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/topology-context/nw-topology-service/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NetworkTopologyService" - parameters: [] - responses: - 200: - description: "tapi.topology.NetworkTopologyService" - schema: - $ref: "#/definitions/tapi.topology.NetworkTopologyService" - 400: - description: "Internal error" - /data/context/topology-context/nw-topology-service/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/topology-context/nw-topology-service/topology={topology-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "topology-uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Topology" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Topology" - schema: - $ref: "#/definitions/tapi.topology.Topology" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Link" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Link" - schema: - $ref: "#/definitions/tapi.topology.Link" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/latency-characteristic={traffic-property-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/node-edge-point={topology-uuid},{node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/resilience-type/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.ResilienceType" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.ResilienceType" - schema: - $ref: "#/definitions/tapi.topology.ResilienceType" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/risk-characteristic={risk-characteristic-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/validation-mechanism={validation-mechanism}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.ValidationMechanism" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "validation-mechanism" - in: "path" - description: "Id of validation-mechanism" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.ValidationMechanism" - schema: - $ref: "#/definitions/tapi.topology.ValidationMechanism" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.topology.Node" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.topology.Node" - schema: - $ref: "#/definitions/tapi.topology.topology.Node" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "aggregated-node-edge-point-node-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/encap-topology/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/latency-characteristic={traffic-property-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroup" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRuleGroup" - schema: - $ref: "#/definitions/tapi.topology.NodeRuleGroup" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/total-size/ - : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" + summary: "removes tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: [] responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/composed-rule-group={topology-uuid},{composed-rule-group-node-uuid},{composed-rule-group-node-rule-group-uuid}/ - : get: + 204: + description: "Object deleted" + /data/context/topology-context/nw-topology-service/: + get: tags: - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroupRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of composed-rule-group" - required: true - type: "string" - - name: "composed-rule-group-node-uuid" - in: "path" - description: "Id of composed-rule-group" - required: true - type: "string" - - name: "composed-rule-group-node-rule-group-uuid" - in: "path" - description: "Id of composed-rule-group" - required: true - type: "string" + summary: "returns tapi.topology.NetworkTopologyService" + description: "none" + parameters: [] responses: 200: - description: "tapi.topology.NodeRuleGroupRef" + description: "tapi.topology.NetworkTopologyService" schema: - $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + $ref: "#/definitions/tapi.topology.NetworkTopologyService" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/cost-characteristic={cost-name}/ - : get: + /data/context/topology-context/nw-topology-service/name={value-name}/: + get: tags: - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "cost-name" + - name: "value-name" in: "path" - description: "Id of cost-characteristic" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.topology.CostCharacteristic" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/ - : get: + /data/context/topology-context/nw-topology-service/topology={topology-uuid}/: + get: tags: - "tapi-topology" - description: "returns tapi.topology.InterRuleGroup" + summary: "returns tapi.topology.TopologyRef" + description: "none" parameters: - - name: "uuid" + - name: "topology-uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" responses: 200: - description: "tapi.topology.InterRuleGroup" + description: "tapi.topology.TopologyRef" schema: - $ref: "#/definitions/tapi.topology.InterRuleGroup" + $ref: "#/definitions/tapi.topology.TopologyRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/associated-node-rule-group={topology-uuid},{associated-node-rule-group-node-uuid},{associated-node-rule-group-node-rule-group-uuid}/ - : get: + /data/context/topology-context/topology={uuid}/: + get: tags: - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroupRef" + summary: "returns tapi.topology.topologycontext.Topology" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of associated-node-rule-group" - required: true - type: "string" - - name: "associated-node-rule-group-node-uuid" - in: "path" - description: "Id of associated-node-rule-group" - required: true - type: "string" - - name: "associated-node-rule-group-node-rule-group-uuid" - in: "path" - description: "Id of associated-node-rule-group" - required: true - type: "string" responses: 200: - description: "tapi.topology.NodeRuleGroupRef" + description: "tapi.topology.Topology" schema: - $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + $ref: "#/definitions/tapi.topology.Topology" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/ - : get: + /data/context/topology-context/topology={uuid}/boundary-node-edge-point={topology-uuid},{node-uuid},{node-edge-point-uuid}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.Capacity" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" + - name: "topology-uuid" in: "path" - description: "Id of topology" + description: "Id of boundary-node-edge-point" required: true type: "string" - name: "node-uuid" in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" + description: "Id of boundary-node-edge-point" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of boundary-node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.topology.NodeEdgePointRef" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ - : get: + /data/context/topology-context/topology={uuid}/link={link-uuid}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.Link" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" + - name: "link-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of link" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.Link" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.Link" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: + /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" + - name: "link-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of link" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ - : get: + /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/total-size/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" + - name: "link-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of link" required: true type: "string" responses: @@ -12246,267 +9837,302 @@ paths: $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ - : get: + /data/context/topology-context/topology={uuid}/link={link-uuid}/cost-characteristic={cost-name}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" + - name: "link-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of link" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "cost-name" in: "path" - description: "Id of inter-rule-group" + description: "Id of cost-characteristic" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.CostCharacteristic" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.CostCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/total-size/ - : get: + /data/context/topology-context/topology={uuid}/link={link-uuid}/latency-characteristic={traffic-property-name}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" + - name: "link-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of link" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "traffic-property-name" in: "path" - description: "Id of inter-rule-group" + description: "Id of latency-characteristic" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.LatencyCharacteristic" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/cost-characteristic={cost-name}/ - : get: + /data/context/topology-context/topology={uuid}/link={link-uuid}/name={value-name}/: + get: tags: - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" + - name: "link-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of link" required: true type: "string" - - name: "cost-name" + - name: "value-name" in: "path" - description: "Id of cost-characteristic" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.topology.CostCharacteristic" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/latency-characteristic={traffic-property-name}/ + ? /data/context/topology-context/topology={uuid}/link={link-uuid}/node-edge-point={topology-uuid},{node-uuid},{node-edge-point-uuid}/ : get: tags: - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "node-uuid" + - name: "link-uuid" in: "path" - description: "Id of node" + description: "Id of link" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "topology-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "node-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "traffic-property-name" + - name: "node-edge-point-uuid" in: "path" - description: "Id of latency-characteristic" + description: "Id of node-edge-point" required: true type: "string" responses: 200: - description: "tapi.topology.LatencyCharacteristic" + description: "tapi.topology.NodeEdgePointRef" schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/name={value-name}/ - : get: + /data/context/topology-context/topology={uuid}/link={link-uuid}/risk-characteristic={risk-characteristic-name}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "node-uuid" + - name: "link-uuid" in: "path" - description: "Id of node" + description: "Id of link" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "risk-characteristic-name" in: "path" - description: "Id of node-rule-group" + description: "Id of risk-characteristic" required: true type: "string" - - name: "inter-rule-group-uuid" + responses: + 200: + description: "tapi.topology.RiskCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of topology" required: true type: "string" - - name: "value-name" + - name: "link-uuid" in: "path" - description: "Id of name" + description: "Id of link" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ - : get: + /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/total-size/: + get: tags: - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "node-uuid" + - name: "link-uuid" in: "path" - description: "Id of node" + description: "Id of link" required: true type: "string" - - name: "node-rule-group-uuid" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/validation-mechanism={validation-mechanism}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.ValidationMechanism" + description: "Provides details of the specific validation mechanism(s) used\ + \ to confirm the presence of an intended topologicalEntity." + parameters: + - name: "uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of topology" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "link-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of link" required: true type: "string" - - name: "risk-characteristic-name" + - name: "validation-mechanism" in: "path" - description: "Id of risk-characteristic" + description: "Id of validation-mechanism" required: true type: "string" responses: 200: - description: "tapi.topology.RiskCharacteristic" + description: "tapi.topology.ValidationMechanism" schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" + $ref: "#/definitions/tapi.topology.ValidationMechanism" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/ - : get: + /data/context/topology-context/topology={uuid}/name={value-name}/: + get: tags: - "tapi-topology" - description: "returns tapi.topology.Rule" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" + - name: "value-name" in: "path" - description: "Id of node-rule-group" + description: "Id of name" required: true type: "string" - - name: "inter-rule-group-uuid" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.topology.Node" + description: "none" + parameters: + - name: "uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of topology" required: true type: "string" - - name: "local-id" + - name: "node-uuid" in: "path" - description: "Id of rule" + description: "Id of node" required: true type: "string" responses: 200: - description: "tapi.topology.Rule" + description: "tapi.topology.topology.Node" schema: - $ref: "#/definitions/tapi.topology.Rule" + $ref: "#/definitions/tapi.topology.topology.Node" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/name={value-name}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -12518,38 +10144,34 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" + - name: "topology-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of aggregated-node-edge-point" required: true type: "string" - - name: "local-id" + - name: "aggregated-node-edge-point-node-uuid" in: "path" - description: "Id of rule" + description: "Id of aggregated-node-edge-point" required: true type: "string" - - name: "value-name" + - name: "node-edge-point-uuid" in: "path" - description: "Id of name" + description: "Id of aggregated-node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.topology.NodeEdgePointRef" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/: + get: tags: - "tapi-topology" - description: "returns tapi.common.Capacity" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" @@ -12561,16 +10183,6 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" responses: 200: description: "tapi.common.Capacity" @@ -12578,44 +10190,38 @@ paths: $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/total-size/: + get: tags: - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" + - name: "node-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of node" required: true type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/cost-characteristic={cost-name}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" @@ -12627,28 +10233,24 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" + - name: "cost-name" in: "path" - description: "Id of inter-rule-group" + description: "Id of cost-characteristic" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.CostCharacteristic" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.CostCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/encap-topology/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.TopologyRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -12660,28 +10262,20 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.TopologyRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.TopologyRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/latency-characteristic={traffic-property-name}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" @@ -12693,28 +10287,26 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" + - name: "traffic-property-name" in: "path" - description: "Id of inter-rule-group" + description: "Id of latency-characteristic" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.LatencyCharacteristic" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/name={value-name}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -12726,28 +10318,24 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" + - name: "value-name" in: "path" - description: "Id of inter-rule-group" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/total-size/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.node.NodeEdgePoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -12759,28 +10347,24 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.node.NodeEdgePoint" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.node.NodeEdgePoint" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/latency-characteristic={traffic-property-name}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{aggregated-node-edge-point-node-edge-point-uuid}/ : get: tags: - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -12792,28 +10376,39 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "traffic-property-name" + - name: "topology-uuid" in: "path" - description: "Id of latency-characteristic" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "aggregated-node-edge-point-node-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "aggregated-node-edge-point-node-edge-point-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" required: true type: "string" responses: 200: - description: "tapi.topology.LatencyCharacteristic" + description: "tapi.topology.NodeEdgePointRef" schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/name={value-name}/: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-capacity/: get: tags: - "tapi-topology" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" @@ -12825,28 +10420,25 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "value-name" + - name: "node-edge-point-uuid" in: "path" - description: "Id of name" + description: "Id of node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/node-edge-point={topology-uuid},{node-edge-point-node-uuid},{node-edge-point-uuid}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-capacity/total-size/ : get: tags: - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -12858,21 +10450,6 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-edge-point-node-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - name: "node-edge-point-uuid" in: "path" description: "Id of node-edge-point" @@ -12880,16 +10457,17 @@ paths: type: "string" responses: 200: - description: "tapi.topology.NodeEdgePointRef" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-cep-layer-protocol={layer-protocol-qualifier}/ : get: tags: - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" + summary: "returns tapi.topology.NepLayerProtocolCapability" + description: "none" parameters: - name: "uuid" in: "path" @@ -12901,28 +10479,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "risk-characteristic-name" + - name: "layer-protocol-qualifier" in: "path" - description: "Id of risk-characteristic" + description: "Id of available-cep-layer-protocol" required: true type: "string" responses: 200: - description: "tapi.topology.RiskCharacteristic" + description: "tapi.topology.NepLayerProtocolCapability" schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" + $ref: "#/definitions/tapi.topology.NepLayerProtocolCapability" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/: get: tags: - - "tapi-topology" - description: "returns tapi.topology.Rule" + - "tapi-connectivity" + summary: "returns tapi.connectivity.context.topologycontext.topology.node.nodeedgepoint.CepList" + description: "none" parameters: - name: "uuid" in: "path" @@ -12934,28 +10513,24 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "local-id" + - name: "node-edge-point-uuid" in: "path" - description: "Id of rule" + description: "Id of node-edge-point" required: true type: "string" responses: 200: - description: "tapi.topology.Rule" + description: "tapi.connectivity.context.topologycontext.topology.node.nodeedgepoint.CepList" schema: - $ref: "#/definitions/tapi.topology.Rule" + $ref: "#/definitions/tapi.connectivity.context.topologycontext.topology.node.nodeedgepoint.CepList" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/name={value-name}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" + - "tapi-connectivity" + summary: "returns tapi.connectivity.ceplist.ConnectionEndPoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -12967,33 +10542,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "local-id" + - name: "node-edge-point-uuid" in: "path" - description: "Id of rule" + description: "Id of node-edge-point" required: true type: "string" - - name: "value-name" + - name: "connection-end-point-uuid" in: "path" - description: "Id of name" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.connectivity.ceplist.ConnectionEndPoint" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.connectivity.ceplist.ConnectionEndPoint" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/aggregated-connection-end-point={topology-uuid},{aggregated-connection-end-point-node-uuid},{aggregated-connection-end-point-node-edge-point-uuid},{aggregated-connection-end-point-connection-end-point-uuid}/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" + - "tapi-connectivity" + summary: "returns tapi.connectivity.ConnectionEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -13005,51 +10576,49 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" + - name: "connection-end-point-uuid" in: "path" - description: "Id of topology" + description: "Id of connection-end-point" required: true type: "string" - - name: "node-uuid" + - name: "topology-uuid" in: "path" - description: "Id of node" + description: "Id of aggregated-connection-end-point" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "aggregated-connection-end-point-node-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of aggregated-connection-end-point" + required: true + type: "string" + - name: "aggregated-connection-end-point-node-edge-point-uuid" + in: "path" + description: "Id of aggregated-connection-end-point" + required: true + type: "string" + - name: "aggregated-connection-end-point-connection-end-point-uuid" + in: "path" + description: "Id of aggregated-connection-end-point" required: true type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.connectivity.ConnectionEndPointRef" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.connectivity.ConnectionEndPointRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/client-node-edge-point={topology-uuid},{client-node-edge-point-node-uuid},{client-node-edge-point-node-edge-point-uuid}/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" + - "tapi-connectivity" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -13061,23 +10630,44 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of client-node-edge-point" + required: true + type: "string" + - name: "client-node-edge-point-node-uuid" + in: "path" + description: "Id of client-node-edge-point" + required: true + type: "string" + - name: "client-node-edge-point-node-edge-point-uuid" + in: "path" + description: "Id of client-node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.NodeEdgePointRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" + - "tapi-oam" + summary: "returns tapi.oam.MepMipList" + description: "none" parameters: - name: "uuid" in: "path" @@ -13089,23 +10679,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.oam.MepMipList" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.oam.MepMipList" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/mep={meg-uuid},{mep-local-id}/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" + - "tapi-oam" + summary: "returns tapi.oam.MepRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -13117,51 +10713,39 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" + - name: "connection-end-point-uuid" in: "path" - description: "Id of topology" + description: "Id of connection-end-point" required: true type: "string" - - name: "node-uuid" + - name: "meg-uuid" in: "path" - description: "Id of node" + description: "Id of mep" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "mep-local-id" in: "path" - description: "Id of node-rule-group" + description: "Id of mep" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.oam.MepRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.oam.MepRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/total-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/mip={meg-uuid},{mip-local-id}/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" + - "tapi-oam" + summary: "returns tapi.oam.MipRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -13173,51 +10757,41 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.node.OwnedNodeEdgePoint" - parameters: - - name: "uuid" + - name: "connection-end-point-uuid" in: "path" - description: "Id of topology" + description: "Id of connection-end-point" required: true type: "string" - - name: "node-uuid" + - name: "meg-uuid" in: "path" - description: "Id of node" + description: "Id of mip" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "mip-local-id" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of mip" required: true type: "string" responses: 200: - description: "tapi.topology.node.OwnedNodeEdgePoint" + description: "tapi.oam.MipRef" schema: - $ref: "#/definitions/tapi.topology.node.OwnedNodeEdgePoint" + $ref: "#/definitions/tapi.oam.MipRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/name={value-name}/ : get: tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" + - "tapi-connectivity" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -13229,38 +10803,34 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "topology-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of aggregated-node-edge-point" + description: "Id of node-edge-point" required: true type: "string" - - name: "aggregated-node-edge-point-node-uuid" + - name: "connection-end-point-uuid" in: "path" - description: "Id of aggregated-node-edge-point" + description: "Id of connection-end-point" required: true type: "string" - - name: "node-edge-point-uuid" + - name: "value-name" in: "path" - description: "Id of aggregated-node-edge-point" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.topology.NodeEdgePointRef" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/odu-connection-end-point-spec/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" + - "tapi-odu" + summary: "returns tapi.odu.OduConnectionEndPointSpec" + description: "none" parameters: - name: "uuid" in: "path" @@ -13272,23 +10842,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.common.Capacity" + description: "tapi.odu.OduConnectionEndPointSpec" schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.odu.OduConnectionEndPointSpec" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/odu-connection-end-point-spec/odu-common/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" + - "tapi-odu" + summary: "returns tapi.odu.OduCommonPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -13300,23 +10876,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.odu.OduCommonPac" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.odu.OduCommonPac" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/odu-connection-end-point-spec/odu-ctp/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" + - "tapi-odu" + summary: "returns tapi.odu.OduCtpPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -13328,23 +10910,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.odu.OduCtpPac" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.odu.OduCtpPac" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/odu-connection-end-point-spec/odu-protection/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" + - "tapi-odu" + summary: "returns tapi.odu.OduProtectionPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -13356,23 +10944,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.odu.OduProtectionPac" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.odu.OduProtectionPac" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/odu-connection-end-point-spec/odu-term-and-adapter/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" + - "tapi-odu" + summary: "returns tapi.odu.OduTerminationAndClientAdaptationPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -13384,23 +10978,34 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.odu.OduTerminationAndClientAdaptationPac" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.odu.OduTerminationAndClientAdaptationPac" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/odu-connection-end-point-spec/odu-term-and-adapter/accepted-payload-type/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" + - "tapi-odu" + summary: "returns tapi.odu.OduPayloadType" + description: "This attribute is applicable when the ODU CTP object instance\ + \ represents a lower order ODU CTP Sink at the client layer of the ODUP/ODU[i]j\ + \ or ODUP/ODUj-21 adaptation function. \r\n This attribute\ + \ is a 2-digit Hex code that indicates the new accepted payload type.\r\n\ + \ Valid values are defined in Table 15-8 of ITU-T Recommendation\ + \ G.709 with one additional value UN_INTERPRETABLE." parameters: - name: "uuid" in: "path" @@ -13412,23 +11017,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.odu.OduPayloadType" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.odu.OduPayloadType" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/total-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/parent-node-edge-point/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" + - "tapi-connectivity" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -13440,23 +11051,31 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.NodeEdgePointRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/: - get: + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/mapped-service-interface-point={service-interface-point-uuid}/ + : get: tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.context.topologycontext.topology.node.ownednodeedgepoint.CepList" + - "tapi-topology" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "NodeEdgePoint mapped to more than ServiceInterfacePoint (slicing/virtualizing)\ + \ or a ServiceInterfacePoint mapped to more than one NodeEdgePoint (load balancing/Resilience)\ + \ should be considered experimental" parameters: - name: "uuid" in: "path" @@ -13468,23 +11087,31 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "service-interface-point-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of mapped-service-interface-point" required: true type: "string" responses: 200: - description: "tapi.connectivity.context.topologycontext.topology.node.ownednodeedgepoint.CepList" + description: "tapi.common.ServiceInterfacePointRef" schema: - $ref: "#/definitions/tapi.connectivity.context.topologycontext.topology.node.ownednodeedgepoint.CepList" + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/name={value-name}/: + get: tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ceplist.ConnectionEndPoint" + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -13496,28 +11123,30 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-edge-point" required: true type: "string" - - name: "connection-end-point-uuid" + - name: "value-name" in: "path" - description: "Id of connection-end-point" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.connectivity.ceplist.ConnectionEndPoint" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.connectivity.ceplist.ConnectionEndPoint" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/aggregated-connection-end-point={topology-uuid},{aggregated-connection-end-point-node-uuid},{node-edge-point-uuid},{aggregated-connection-end-point-connection-end-point-uuid}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/odu-node-edge-point-spec/ : get: tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionEndPointRef" + - "tapi-odu" + summary: "returns tapi.odu.OduNodeEdgePointSpec" + description: "Augments the base LayerProtocol information in NodeEdgePoint with\ + \ ODU-specific information" parameters: - name: "uuid" in: "path" @@ -13529,48 +11158,24 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of aggregated-connection-end-point" - required: true - type: "string" - - name: "aggregated-connection-end-point-node-uuid" - in: "path" - description: "Id of aggregated-connection-end-point" - required: true - type: "string" - name: "node-edge-point-uuid" in: "path" - description: "Id of aggregated-connection-end-point" - required: true - type: "string" - - name: "aggregated-connection-end-point-connection-end-point-uuid" - in: "path" - description: "Id of aggregated-connection-end-point" + description: "Id of node-edge-point" required: true type: "string" responses: 200: - description: "tapi.connectivity.ConnectionEndPointRef" + description: "tapi.odu.OduNodeEdgePointSpec" schema: - $ref: "#/definitions/tapi.connectivity.ConnectionEndPointRef" + $ref: "#/definitions/tapi.odu.OduNodeEdgePointSpec" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/client-node-edge-point={topology-uuid},{client-node-edge-point-node-uuid},{node-edge-point-uuid}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/odu-node-edge-point-spec/odu-pool/ : get: tags: - - "tapi-connectivity" - description: "returns tapi.topology.NodeEdgePointRef" + - "tapi-odu" + summary: "returns tapi.odu.OduPoolPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -13582,43 +11187,25 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of client-node-edge-point" - required: true - type: "string" - - name: "client-node-edge-point-node-uuid" - in: "path" - description: "Id of client-node-edge-point" - required: true - type: "string" - name: "node-edge-point-uuid" in: "path" - description: "Id of client-node-edge-point" + description: "Id of node-edge-point" required: true type: "string" responses: 200: - description: "tapi.topology.NodeEdgePointRef" + description: "tapi.odu.OduPoolPac" schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + $ref: "#/definitions/tapi.odu.OduPoolPac" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/total-potential-capacity/ : get: tags: - - "tapi-oam" - description: "returns tapi.oam.MepMipList" + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" @@ -13630,28 +11217,25 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of connection-end-point" + description: "Id of node-edge-point" required: true type: "string" responses: 200: - description: "tapi.oam.MepMipList" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.oam.MepMipList" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/mep={meg-uuid},{mep-local-id}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/total-potential-capacity/total-size/ : get: tags: - - "tapi-oam" - description: "returns tapi.oam.MepRef" + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -13663,38 +11247,24 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "meg-uuid" - in: "path" - description: "Id of mep" - required: true - type: "string" - - name: "mep-local-id" + - name: "node-edge-point-uuid" in: "path" - description: "Id of mep" + description: "Id of node-edge-point" required: true type: "string" responses: 200: - description: "tapi.oam.MepRef" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.oam.MepRef" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/mip={meg-uuid},{mip-local-id}/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/: + get: tags: - - "tapi-oam" - description: "returns tapi.oam.MipRef" + - "tapi-topology" + summary: "returns tapi.topology.NodeRuleGroup" + description: "none" parameters: - name: "uuid" in: "path" @@ -13706,38 +11276,54 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-rule-group" required: true type: "string" - - name: "connection-end-point-uuid" + responses: + 200: + description: "tapi.topology.NodeRuleGroup" + schema: + $ref: "#/definitions/tapi.topology.NodeRuleGroup" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" in: "path" - description: "Id of connection-end-point" + description: "Id of topology" required: true type: "string" - - name: "meg-uuid" + - name: "node-uuid" in: "path" - description: "Id of mip" + description: "Id of node" required: true type: "string" - - name: "mip-local-id" + - name: "node-rule-group-uuid" in: "path" - description: "Id of mip" + description: "Id of node-rule-group" required: true type: "string" responses: 200: - description: "tapi.oam.MipRef" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.oam.MipRef" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/name={value-name}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/total-size/ : get: tags: - - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -13749,33 +11335,24 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "value-name" + - name: "node-rule-group-uuid" in: "path" - description: "Id of name" + description: "Id of node-rule-group" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/odu-connection-end-point-spec/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/composed-rule-group={topology-uuid},{composed-rule-group-node-uuid},{composed-rule-group-node-rule-group-uuid}/ : get: tags: - - "tapi-odu" - description: "returns tapi.odu.OduConnectionEndPointSpec" + - "tapi-topology" + summary: "returns tapi.topology.NodeRuleGroupRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -13787,28 +11364,40 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "topology-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of composed-rule-group" required: true type: "string" - - name: "connection-end-point-uuid" + - name: "composed-rule-group-node-uuid" in: "path" - description: "Id of connection-end-point" + description: "Id of composed-rule-group" + required: true + type: "string" + - name: "composed-rule-group-node-rule-group-uuid" + in: "path" + description: "Id of composed-rule-group" required: true type: "string" responses: 200: - description: "tapi.odu.OduConnectionEndPointSpec" + description: "tapi.topology.NodeRuleGroupRef" schema: - $ref: "#/definitions/tapi.odu.OduConnectionEndPointSpec" + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/odu-connection-end-point-spec/odu-common/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/cost-characteristic={cost-name}/ : get: tags: - - "tapi-odu" - description: "returns tapi.odu.OduCommonPac" + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" @@ -13820,28 +11409,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-rule-group" required: true type: "string" - - name: "connection-end-point-uuid" + - name: "cost-name" in: "path" - description: "Id of connection-end-point" + description: "Id of cost-characteristic" required: true type: "string" responses: 200: - description: "tapi.odu.OduCommonPac" + description: "tapi.topology.CostCharacteristic" schema: - $ref: "#/definitions/tapi.odu.OduCommonPac" + $ref: "#/definitions/tapi.topology.CostCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/odu-connection-end-point-spec/odu-ctp/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/ : get: tags: - - "tapi-odu" - description: "returns tapi.odu.OduCtpPac" + - "tapi-topology" + summary: "returns tapi.topology.InterRuleGroup" + description: "none" parameters: - name: "uuid" in: "path" @@ -13853,28 +11443,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-rule-group" required: true type: "string" - - name: "connection-end-point-uuid" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of connection-end-point" + description: "Id of inter-rule-group" required: true type: "string" responses: 200: - description: "tapi.odu.OduCtpPac" + description: "tapi.topology.InterRuleGroup" schema: - $ref: "#/definitions/tapi.odu.OduCtpPac" + $ref: "#/definitions/tapi.topology.InterRuleGroup" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/odu-connection-end-point-spec/odu-protection/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/associated-node-rule-group={topology-uuid},{associated-node-rule-group-node-uuid},{associated-node-rule-group-node-rule-group-uuid}/ : get: tags: - - "tapi-odu" - description: "returns tapi.odu.OduProtectionPac" + - "tapi-topology" + summary: "returns tapi.topology.NodeRuleGroupRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -13886,28 +11477,44 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-rule-group" required: true type: "string" - - name: "connection-end-point-uuid" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of connection-end-point" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of associated-node-rule-group" + required: true + type: "string" + - name: "associated-node-rule-group-node-uuid" + in: "path" + description: "Id of associated-node-rule-group" + required: true + type: "string" + - name: "associated-node-rule-group-node-rule-group-uuid" + in: "path" + description: "Id of associated-node-rule-group" required: true type: "string" responses: 200: - description: "tapi.odu.OduProtectionPac" + description: "tapi.topology.NodeRuleGroupRef" schema: - $ref: "#/definitions/tapi.odu.OduProtectionPac" + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/odu-connection-end-point-spec/odu-term-and-adapter/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/ : get: tags: - - "tapi-odu" - description: "returns tapi.odu.OduTerminationAndClientAdaptationPac" + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" @@ -13919,28 +11526,30 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-rule-group" required: true type: "string" - - name: "connection-end-point-uuid" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of connection-end-point" + description: "Id of inter-rule-group" required: true type: "string" responses: 200: - description: "tapi.odu.OduTerminationAndClientAdaptationPac" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.odu.OduTerminationAndClientAdaptationPac" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/odu-connection-end-point-spec/odu-term-and-adapter/accepted-payload-type/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/total-size/ : get: tags: - - "tapi-odu" - description: "returns tapi.odu.OduPayloadType" + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -13952,28 +11561,30 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-rule-group" required: true type: "string" - - name: "connection-end-point-uuid" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of connection-end-point" + description: "Id of inter-rule-group" required: true type: "string" responses: 200: - description: "tapi.odu.OduPayloadType" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.odu.OduPayloadType" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/parent-node-edge-point/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/cost-characteristic={cost-name}/ : get: tags: - - "tapi-connectivity" - description: "returns tapi.topology.NodeEdgePointRef" + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" @@ -13985,28 +11596,35 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-rule-group" required: true type: "string" - - name: "connection-end-point-uuid" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of connection-end-point" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" required: true type: "string" responses: 200: - description: "tapi.topology.NodeEdgePointRef" + description: "tapi.topology.CostCharacteristic" schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + $ref: "#/definitions/tapi.topology.CostCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/mapped-service-interface-point={service-interface-point-uuid}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/latency-characteristic={traffic-property-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.ServiceInterfacePointRef" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" @@ -14018,28 +11636,36 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of inter-rule-group" required: true type: "string" - - name: "service-interface-point-uuid" + - name: "traffic-property-name" in: "path" - description: "Id of mapped-service-interface-point" + description: "Id of latency-characteristic" required: true type: "string" responses: 200: - description: "tapi.common.ServiceInterfacePointRef" + description: "tapi.topology.LatencyCharacteristic" schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/name={value-name}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/name={value-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -14051,9 +11677,14 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of inter-rule-group" required: true type: "string" - name: "value-name" @@ -14068,11 +11699,13 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/odu-node-edge-point-spec/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ : get: tags: - - "tapi-odu" - description: "returns tapi.odu.OduNodeEdgePointSpec" + - "tapi-topology" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." parameters: - name: "uuid" in: "path" @@ -14084,23 +11717,34 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "risk-characteristic-name" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of risk-characteristic" required: true type: "string" responses: 200: - description: "tapi.odu.OduNodeEdgePointSpec" + description: "tapi.topology.RiskCharacteristic" schema: - $ref: "#/definitions/tapi.odu.OduNodeEdgePointSpec" + $ref: "#/definitions/tapi.topology.RiskCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/odu-node-edge-point-spec/odu-pool/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/ : get: tags: - - "tapi-odu" - description: "returns tapi.odu.OduPoolPac" + - "tapi-topology" + summary: "returns tapi.topology.Rule" + description: "none" parameters: - name: "uuid" in: "path" @@ -14112,23 +11756,36 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "local-id" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of rule" required: true type: "string" responses: 200: - description: "tapi.odu.OduPoolPac" + description: "tapi.topology.Rule" schema: - $ref: "#/definitions/tapi.odu.OduPoolPac" + $ref: "#/definitions/tapi.topology.Rule" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/name={value-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.Capacity" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -14140,23 +11797,40 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" + - name: "value-name" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.common.Capacity" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/ : get: tags: - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" @@ -14168,23 +11842,30 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of inter-rule-group" required: true type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/total-size/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -14196,9 +11877,14 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of inter-rule-group" required: true type: "string" responses: @@ -14208,11 +11894,13 @@ paths: $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/latency-characteristic={traffic-property-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" @@ -14224,23 +11912,31 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "traffic-property-name" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of latency-characteristic" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.LatencyCharacteristic" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/name={value-name}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -14252,23 +11948,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "value-name" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/node-edge-point={topology-uuid},{node-edge-point-node-uuid},{node-edge-point-uuid}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -14280,23 +11982,40 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "node-edge-point-node-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.NodeEdgePointRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/total-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." parameters: - name: "uuid" in: "path" @@ -14308,23 +12027,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "risk-characteristic-name" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of risk-characteristic" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.RiskCharacteristic" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.RiskCharacteristic" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/: get: tags: - "tapi-topology" - description: "returns tapi.common.Capacity" + summary: "returns tapi.topology.Rule" + description: "none" parameters: - name: "uuid" in: "path" @@ -14336,41 +12061,31 @@ paths: description: "Id of node" required: true type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of topology" + description: "Id of node-rule-group" required: true type: "string" - - name: "node-uuid" + - name: "local-id" in: "path" - description: "Id of node" + description: "Id of rule" required: true type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.topology.Rule" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.topology.Rule" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/name={value-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -14382,18 +12097,35 @@ paths: description: "Id of node" required: true type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" @@ -14405,18 +12137,25 @@ paths: description: "Id of node" required: true type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/total-size/ + : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -14428,6 +12167,11 @@ paths: description: "Id of node" required: true type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" responses: 200: description: "tapi.common.CapacityValue" @@ -14435,11 +12179,13 @@ paths: $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" @@ -14453,16 +12199,18 @@ paths: type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/total-size/: get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -14485,6 +12233,8 @@ paths: post: tags: - "tapi-path-computation" + summary: "operates on tapi.path.computation.ComputeP2PPath" + description: "operates on tapi.path.computation.ComputeP2PPath" parameters: - in: "body" name: "tapi.path.computation.computep2ppath.Input.body-param" @@ -14506,6 +12256,8 @@ paths: post: tags: - "tapi-connectivity" + summary: "operates on tapi.connectivity.CreateConnectivityService" + description: "operates on tapi.connectivity.CreateConnectivityService" parameters: - in: "body" name: "tapi.connectivity.createconnectivityservice.Input.body-param" @@ -14527,6 +12279,8 @@ paths: post: tags: - "tapi-notification" + summary: "operates on tapi.notification.CreateNotificationSubscriptionService" + description: "operates on tapi.notification.CreateNotificationSubscriptionService" parameters: - in: "body" name: "tapi.notification.createnotificationsubscriptionservice.Input.body-param" @@ -14548,6 +12302,8 @@ paths: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.CreateOamJob" + description: "operates on tapi.oam.CreateOamJob" parameters: - in: "body" name: "tapi.oam.createoamjob.Input.body-param" @@ -14565,23 +12321,48 @@ paths: description: "No response" 400: description: "Internal error" - /operations/create-oam-service-end-point/: + /operations/create-oam-profile/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.CreateOamProfile" + description: "operates on tapi.oam.CreateOamProfile" + parameters: + - in: "body" + name: "tapi.oam.createoamprofile.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.createoamprofile.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.CreateOamProfile" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/create-oam-service-point/: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.CreateOamServicePoint" + description: "operates on tapi.oam.CreateOamServicePoint" parameters: - in: "body" - name: "tapi.oam.createoamserviceendpoint.Input.body-param" + name: "tapi.oam.createoamservicepoint.Input.body-param" required: false schema: properties: input: - $ref: "#/definitions/tapi.oam.createoamserviceendpoint.Input" + $ref: "#/definitions/tapi.oam.createoamservicepoint.Input" responses: 200: description: "Correct response" schema: - $ref: "#/definitions/tapi.oam.CreateOamServiceEndPoint" + $ref: "#/definitions/tapi.oam.CreateOamServicePoint" 201: description: "No response" 400: @@ -14590,6 +12371,8 @@ paths: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.CreateOamService" + description: "operates on tapi.oam.CreateOamService" parameters: - in: "body" name: "tapi.oam.createoamservice.Input.body-param" @@ -14611,6 +12394,8 @@ paths: post: tags: - "tapi-connectivity" + summary: "operates on tapi.connectivity.DeleteConnectivityService" + description: "operates on tapi.connectivity.DeleteConnectivityService" parameters: - in: "body" name: "tapi.connectivity.deleteconnectivityservice.Input.body-param" @@ -14628,6 +12413,8 @@ paths: post: tags: - "tapi-notification" + summary: "operates on tapi.notification.DeleteNotificationSubscriptionService" + description: "operates on tapi.notification.DeleteNotificationSubscriptionService" parameters: - in: "body" name: "tapi.notification.deletenotificationsubscriptionservice.Input.body-param" @@ -14635,45 +12422,64 @@ paths: schema: properties: input: - $ref: "#/definitions/tapi.notification.deletenotificationsubscriptionservice.Input" + $ref: "#/definitions/tapi.notification.deletenotificationsubscriptionservice.Input" + responses: + 201: + description: "No response" + 400: + description: "Internal error" + /operations/delete-oam-job/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.DeleteOamJob" + description: "operates on tapi.oam.DeleteOamJob" + parameters: + - in: "body" + name: "tapi.oam.deleteoamjob.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.deleteoamjob.Input" responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.DeleteNotificationSubscriptionService" 201: description: "No response" 400: description: "Internal error" - /operations/delete-oam-job/: + /operations/delete-oam-profile/: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.DeleteOamProfile" + description: "operates on tapi.oam.DeleteOamProfile" parameters: - in: "body" - name: "tapi.oam.deleteoamjob.Input.body-param" + name: "tapi.oam.deleteoamprofile.Input.body-param" required: false schema: properties: input: - $ref: "#/definitions/tapi.oam.deleteoamjob.Input" + $ref: "#/definitions/tapi.oam.deleteoamprofile.Input" responses: 201: description: "No response" 400: description: "Internal error" - /operations/delete-oam-service-end-point/: + /operations/delete-oam-service-point/: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.DeleteOamServicePoint" + description: "operates on tapi.oam.DeleteOamServicePoint" parameters: - in: "body" - name: "tapi.oam.deleteoamserviceendpoint.Input.body-param" + name: "tapi.oam.deleteoamservicepoint.Input.body-param" required: false schema: properties: input: - $ref: "#/definitions/tapi.oam.deleteoamserviceendpoint.Input" + $ref: "#/definitions/tapi.oam.deleteoamservicepoint.Input" responses: 201: description: "No response" @@ -14683,6 +12489,8 @@ paths: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.DeleteOamService" + description: "operates on tapi.oam.DeleteOamService" parameters: - in: "body" name: "tapi.oam.deleteoamservice.Input.body-param" @@ -14700,6 +12508,8 @@ paths: post: tags: - "tapi-path-computation" + summary: "operates on tapi.path.computation.DeleteP2PPath" + description: "operates on tapi.path.computation.DeleteP2PPath" parameters: - in: "body" name: "tapi.path.computation.deletep2ppath.Input.body-param" @@ -14721,6 +12531,8 @@ paths: post: tags: - "tapi-connectivity" + summary: "operates on tapi.connectivity.GetConnectionDetails" + description: "operates on tapi.connectivity.GetConnectionDetails" parameters: - in: "body" name: "tapi.connectivity.getconnectiondetails.Input.body-param" @@ -14742,6 +12554,8 @@ paths: post: tags: - "tapi-connectivity" + summary: "operates on tapi.connectivity.GetConnectionEndPointDetails" + description: "operates on tapi.connectivity.GetConnectionEndPointDetails" parameters: - in: "body" name: "tapi.connectivity.getconnectionendpointdetails.Input.body-param" @@ -14763,6 +12577,8 @@ paths: post: tags: - "tapi-connectivity" + summary: "operates on tapi.connectivity.GetConnectivityServiceDetails" + description: "operates on tapi.connectivity.GetConnectivityServiceDetails" parameters: - in: "body" name: "tapi.connectivity.getconnectivityservicedetails.Input.body-param" @@ -14798,6 +12614,8 @@ paths: post: tags: - "tapi-topology" + summary: "operates on tapi.topology.GetLinkDetails" + description: "operates on tapi.topology.GetLinkDetails" parameters: - in: "body" name: "tapi.topology.getlinkdetails.Input.body-param" @@ -14819,6 +12637,8 @@ paths: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.GetMeg" + description: "operates on tapi.oam.GetMeg" parameters: - in: "body" name: "tapi.oam.getmeg.Input.body-param" @@ -14840,6 +12660,8 @@ paths: post: tags: - "tapi-topology" + summary: "operates on tapi.topology.GetNodeDetails" + description: "operates on tapi.topology.GetNodeDetails" parameters: - in: "body" name: "tapi.topology.getnodedetails.Input.body-param" @@ -14861,6 +12683,8 @@ paths: post: tags: - "tapi-topology" + summary: "operates on tapi.topology.GetNodeEdgePointDetails" + description: "operates on tapi.topology.GetNodeEdgePointDetails" parameters: - in: "body" name: "tapi.topology.getnodeedgepointdetails.Input.body-param" @@ -14882,6 +12706,8 @@ paths: post: tags: - "tapi-notification" + summary: "operates on tapi.notification.GetNotificationList" + description: "operates on tapi.notification.GetNotificationList" parameters: - in: "body" name: "tapi.notification.getnotificationlist.Input.body-param" @@ -14903,6 +12729,8 @@ paths: post: tags: - "tapi-notification" + summary: "operates on tapi.notification.GetNotificationSubscriptionServiceDetails" + description: "operates on tapi.notification.GetNotificationSubscriptionServiceDetails" parameters: - in: "body" name: "tapi.notification.getnotificationsubscriptionservicedetails.Input.body-param" @@ -14934,10 +12762,26 @@ paths: description: "No response" 400: description: "Internal error" + /operations/get-oam-job-list/: + post: + tags: + - "tapi-oam" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetOamJobList" + 201: + description: "No response" + 400: + description: "Internal error" /operations/get-oam-job/: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.GetOamJob" + description: "operates on tapi.oam.GetOamJob" parameters: - in: "body" name: "tapi.oam.getoamjob.Input.body-param" @@ -14955,23 +12799,39 @@ paths: description: "No response" 400: description: "Internal error" - /operations/get-oam-service-end-point/: + /operations/get-oam-profile-list/: + post: + tags: + - "tapi-oam" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetOamProfileList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-oam-profile/: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.GetOamProfile" + description: "operates on tapi.oam.GetOamProfile" parameters: - in: "body" - name: "tapi.oam.getoamserviceendpoint.Input.body-param" + name: "tapi.oam.getoamprofile.Input.body-param" required: false schema: properties: input: - $ref: "#/definitions/tapi.oam.getoamserviceendpoint.Input" + $ref: "#/definitions/tapi.oam.getoamprofile.Input" responses: 200: description: "Correct response" schema: - $ref: "#/definitions/tapi.oam.GetOamServiceEndPoint" + $ref: "#/definitions/tapi.oam.GetOamProfile" 201: description: "No response" 400: @@ -14990,10 +12850,35 @@ paths: description: "No response" 400: description: "Internal error" + /operations/get-oam-service-point/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.GetOamServicePoint" + description: "operates on tapi.oam.GetOamServicePoint" + parameters: + - in: "body" + name: "tapi.oam.getoamservicepoint.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.getoamservicepoint.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetOamServicePoint" + 201: + description: "No response" + 400: + description: "Internal error" /operations/get-oam-service/: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.GetOamService" + description: "operates on tapi.oam.GetOamService" parameters: - in: "body" name: "tapi.oam.getoamservice.Input.body-param" @@ -15015,6 +12900,8 @@ paths: post: tags: - "tapi-common" + summary: "operates on tapi.common.GetServiceInterfacePointDetails" + description: "operates on tapi.common.GetServiceInterfacePointDetails" parameters: - in: "body" name: "tapi.common.getserviceinterfacepointdetails.Input.body-param" @@ -15064,6 +12951,8 @@ paths: post: tags: - "tapi-topology" + summary: "operates on tapi.topology.GetTopologyDetails" + description: "operates on tapi.topology.GetTopologyDetails" parameters: - in: "body" name: "tapi.topology.gettopologydetails.Input.body-param" @@ -15099,6 +12988,8 @@ paths: post: tags: - "tapi-path-computation" + summary: "operates on tapi.path.computation.OptimizeP2PPath" + description: "operates on tapi.path.computation.OptimizeP2PPath" parameters: - in: "body" name: "tapi.path.computation.optimizep2ppath.Input.body-param" @@ -15120,6 +13011,8 @@ paths: post: tags: - "tapi-connectivity" + summary: "operates on tapi.connectivity.UpdateConnectivityService" + description: "operates on tapi.connectivity.UpdateConnectivityService" parameters: - in: "body" name: "tapi.connectivity.updateconnectivityservice.Input.body-param" @@ -15141,6 +13034,8 @@ paths: post: tags: - "tapi-notification" + summary: "operates on tapi.notification.UpdateNotificationSubscriptionService" + description: "operates on tapi.notification.UpdateNotificationSubscriptionService" parameters: - in: "body" name: "tapi.notification.updatenotificationsubscriptionservice.Input.body-param" @@ -15162,6 +13057,8 @@ paths: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.UpdateOamJob" + description: "operates on tapi.oam.UpdateOamJob" parameters: - in: "body" name: "tapi.oam.updateoamjob.Input.body-param" @@ -15179,23 +13076,48 @@ paths: description: "No response" 400: description: "Internal error" - /operations/update-oam-service-end-point/: + /operations/update-oam-profile/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.UpdateOamProfile" + description: "operates on tapi.oam.UpdateOamProfile" + parameters: + - in: "body" + name: "tapi.oam.updateoamprofile.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.updateoamprofile.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.UpdateOamProfile" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/update-oam-service-point/: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.UpdateOamServicePoint" + description: "operates on tapi.oam.UpdateOamServicePoint" parameters: - in: "body" - name: "tapi.oam.updateoamserviceendpoint.Input.body-param" + name: "tapi.oam.updateoamservicepoint.Input.body-param" required: false schema: properties: input: - $ref: "#/definitions/tapi.oam.updateoamserviceendpoint.Input" + $ref: "#/definitions/tapi.oam.updateoamservicepoint.Input" responses: 200: description: "Correct response" schema: - $ref: "#/definitions/tapi.oam.UpdateOamServiceEndPoint" + $ref: "#/definitions/tapi.oam.UpdateOamServicePoint" 201: description: "No response" 400: @@ -15204,6 +13126,8 @@ paths: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.UpdateOamService" + description: "operates on tapi.oam.UpdateOamService" parameters: - in: "body" name: "tapi.oam.updateoamservice.Input.body-param" @@ -15225,6 +13149,8 @@ paths: post: tags: - "tapi-common" + summary: "operates on tapi.common.UpdateServiceInterfacePoint" + description: "operates on tapi.common.UpdateServiceInterfacePoint" parameters: - in: "body" name: "tapi.common.updateserviceinterfacepoint.Input.body-param" @@ -15256,45 +13182,9 @@ definitions: enum: - "LOCKED" - "UNLOCKED" - tapi.common.BandwidthProfile: - type: "object" - properties: - committed-information-rate: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - coupling-flag: - type: "boolean" - description: "none" - default: false - bw-profile-type: - description: "none" - $ref: "#/definitions/tapi.common.BandwidthProfileType" - peak-information-rate: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - committed-burst-size: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - peak-burst-size: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - color-aware: - type: "boolean" - description: "none" - default: false - tapi.common.BandwidthProfileType: - type: "string" - enum: - - "MEF_10.x" - - "RFC_2697" - - "RFC_2698" - - "RFC_4115" tapi.common.Capacity: type: "object" properties: - bandwidth-profile: - description: "none" - $ref: "#/definitions/tapi.common.BandwidthProfile" total-size: description: "Total capacity of the TopologicalEntity in MB/s. In case of\ \ bandwidthProfile, this is expected to same as the committedInformationRate." @@ -15336,9 +13226,9 @@ definitions: allOf: - $ref: "#/definitions/tapi.common.TapiContext" - $ref: "#/definitions/tapi.connectivity.ContextAugmentation4" - - $ref: "#/definitions/tapi.notification.ContextAugmentation2" - - $ref: "#/definitions/tapi.oam.ContextAugmentation1" - - $ref: "#/definitions/tapi.path.computation.ContextAugmentation3" + - $ref: "#/definitions/tapi.notification.ContextAugmentation1" + - $ref: "#/definitions/tapi.oam.ContextAugmentation3" + - $ref: "#/definitions/tapi.path.computation.ContextAugmentation2" - $ref: "#/definitions/tapi.topology.ContextAugmentation5" tapi.common.DirectiveValue: type: "string" @@ -15369,21 +13259,21 @@ definitions: properties: name: type: "array" - description: "List of names. A property of an entity with a value that is\ - \ unique in some namespace but may change during the life of the entity.\ - \ A name carries no semantics with respect to the purpose of the entity." + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." items: $ref: "#/definitions/tapi.common.NameAndValue" uuid: type: "string" description: "UUID: An identifier that is universally unique within an identifier\ - \ space, where the identifier space is itself globally unique, and immutable.\ - \ An UUID carries no semantics with respect to the purpose or state of the\ - \ entity.\r\n UUID here uses string representation as\ - \ defined in RFC 4122. The canonical representation uses lowercase characters.\r\ - \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ - \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ - \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a UUID\ + \ in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.common.LayerProtocolName: type: "string" enum: @@ -15404,9 +13294,9 @@ definitions: properties: name: type: "array" - description: "List of names. A property of an entity with a value that is\ - \ unique in some namespace but may change during the life of the entity.\ - \ A name carries no semantics with respect to the purpose of the entity." + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." items: $ref: "#/definitions/tapi.common.NameAndValue" local-id: @@ -15468,7 +13358,7 @@ definitions: $ref: "#/definitions/tapi.common.LayerProtocolName" description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ \ termination and adaptation functions of one or more transport layers. \r\ - \n The structure of LTP supports all transport protocols including\ + \n The structure of LTP supports all transport protocols including\ \ circuit and packet forms." tapi.common.ServiceInterfacePointRef: type: "object" @@ -15502,11 +13392,11 @@ definitions: type: "object" properties: termination-direction: - description: "The overall directionality of the LP. \r\n \ - \ - A BIDIRECTIONAL LP will have some SINK and/or SOURCE flowss.\r\n \ - \ - A SINK LP can only contain elements with SINK flows\ - \ or CONTRA_DIRECTION_SOURCE flows\r\n - A SOURCE LP\ - \ can only contain SOURCE flows or CONTRA_DIRECTION_SINK flows" + description: "The overall directionality of the LP. \r\n -\ + \ A BIDIRECTIONAL LP will have some SINK and/or SOURCE flowss.\r\n \ + \ - A SINK LP can only contain elements with SINK flows or CONTRA_DIRECTION_SOURCE\ + \ flows\r\n - A SOURCE LP can only contain SOURCE flows or\ + \ CONTRA_DIRECTION_SINK flows" $ref: "#/definitions/tapi.common.TerminationDirection" termination-state: description: "Indicates whether the layer is terminated and if so how." @@ -15564,9 +13454,16 @@ definitions: tapi.common.getserviceinterfacepointdetails.Input: type: "object" properties: - sip-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.common.getserviceinterfacepointdetails.Output: type: "object" properties: @@ -15584,9 +13481,16 @@ definitions: tapi.common.updateserviceinterfacepoint.Input: type: "object" properties: - sip-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" state: description: "none" $ref: "#/definitions/tapi.common.AdministrativeState" @@ -15606,11 +13510,11 @@ definitions: description: "An Connection object supports a recursive aggregation relationship\ \ such that the internal construction of an Connection can be exposed\ \ as multiple lower level Connection objects (partitioning).\r\n \ - \ Aggregation is used as for the Node/Topology to allow\ - \ changes in hierarchy. \r\n Connection aggregation\ - \ reflects Node/Topology aggregation. \r\n The FC represents\ - \ a Cross-Connection in an NE. The Cross-Connection in an NE is not necessarily\ - \ the lowest level of FC partitioning." + \ Aggregation is used as for the Node/Topology to allow changes\ + \ in hierarchy. \r\n Connection aggregation reflects Node/Topology\ + \ aggregation. \r\n The FC represents a Cross-Connection\ + \ in an NE. The Cross-Connection in an NE is not necessarily the lowest\ + \ level of FC partitioning." items: $ref: "#/definitions/tapi.connectivity.ConnectionRef" switch-control: @@ -15623,6 +13527,9 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.connectivity.Route" + bounding-node: + description: "none" + $ref: "#/definitions/tapi.topology.NodeRef" layer-protocol-name: description: "none" $ref: "#/definitions/tapi.common.LayerProtocolName" @@ -15636,9 +13543,8 @@ definitions: $ref: "#/definitions/tapi.common.ForwardingDirection" description: "The ForwardingConstruct (FC) object class models enabled potential\ \ for forwarding between two or more LTPs and like the LTP supports any transport\ - \ protocol including all circuit and packet forms.\r\n At the\ - \ lowest level of recursion, a FC represents a cross-connection within an\ - \ NE." + \ protocol including all circuit and packet forms.\r\n At the lowest\ + \ level of recursion, a FC represents a cross-connection within an NE." tapi.connectivity.ConnectionEndPoint: allOf: - $ref: "#/definitions/tapi.common.GlobalClass" @@ -15646,6 +13552,9 @@ definitions: - $ref: "#/definitions/tapi.common.TerminationPac" - type: "object" properties: + protection-role: + description: "none" + $ref: "#/definitions/tapi.connectivity.ProtectionRole" client-node-edge-point: type: "array" description: "none" @@ -15675,7 +13584,7 @@ definitions: $ref: "#/definitions/tapi.common.PortDirection" description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ \ termination and adaptation functions of one or more transport layers. \r\ - \n The structure of LTP supports all transport protocols including\ + \n The structure of LTP supports all transport protocols including\ \ circuit and packet forms." tapi.connectivity.ConnectionEndPointRef: allOf: @@ -15685,7 +13594,7 @@ definitions: connection-end-point-uuid: type: "string" description: "none" - x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:owned-node-edge-point/tapi-connectivity:cep-list/tapi-connectivity:connection-end-point/tapi-connectivity:uuid" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:node-edge-point/tapi-connectivity:cep-list/tapi-connectivity:connection-end-point/tapi-connectivity:uuid" description: "none" tapi.connectivity.ConnectionRef: type: "object" @@ -15697,15 +13606,9 @@ definitions: tapi.connectivity.ConnectivityConstraint: type: "object" properties: - service-layer: - description: "none" - $ref: "#/definitions/tapi.common.LayerProtocolName" schedule: description: "none" $ref: "#/definitions/tapi.common.TimeRange" - connectivity-direction: - description: "none" - $ref: "#/definitions/tapi.common.ForwardingDirection" requested-capacity: description: "none" $ref: "#/definitions/tapi.common.Capacity" @@ -15718,7 +13621,7 @@ definitions: type: "string" description: "An abstract value the meaning of which is mutually agreed \ \ typically represents metrics such as - Class of service, priority, resiliency,\ - \ availability" + \ availability\r\n Class of Service Name." service-type: description: "none" $ref: "#/definitions/tapi.connectivity.ServiceType" @@ -15742,27 +13645,42 @@ definitions: allOf: - $ref: "#/definitions/tapi.common.AdminStatePac" - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" - - $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" - - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - type: "object" properties: + topology-constraint: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" end-point: type: "array" description: "none" items: $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" + resilience-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" connection: type: "array" description: "none" items: $ref: "#/definitions/tapi.connectivity.ConnectionRef" + connectivity-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + direction: + description: "none" + $ref: "#/definitions/tapi.common.ForwardingDirection" description: "The ForwardingConstruct (FC) object class models enabled potential\ \ for forwarding between two or more LTPs and like the LTP supports any transport\ - \ protocol including all circuit and packet forms.\r\n At the\ - \ lowest level of recursion, a FC represents a cross-connection within an\ - \ NE." + \ protocol including all circuit and packet forms.\r\n At the lowest\ + \ level of recursion, a FC represents a cross-connection within an NE." tapi.connectivity.ConnectivityServiceEndPoint: allOf: - $ref: "#/definitions/tapi.common.AdminStatePac" @@ -15781,6 +13699,9 @@ definitions: service-interface-point: description: "none" $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + peer-fwd-connectivity-service-end-point: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" layer-protocol-name: description: "none" $ref: "#/definitions/tapi.common.LayerProtocolName" @@ -15792,23 +13713,29 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.connectivity.ConnectionEndPointRef" + server-connectivity-service-end-point: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" direction: description: "The orientation of defined flow at the EndPoint." $ref: "#/definitions/tapi.common.PortDirection" capacity: description: "none" $ref: "#/definitions/tapi.common.Capacity" + protecting-connectivity-service-end-point: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" description: "The association of the FC to LTPs is made via EndPoints.\r\n \ - \ The EndPoint (EP) object class models the access to the FC\ - \ function. \r\n The traffic forwarding between the associated\ - \ EPs of the FC depends upon the type of FC and may be associated with FcSwitch\ - \ object instances. \r\n In cases where there is resilience\ - \ the EndPoint may convey the resilience role of the access to the FC. \r\n\ - \ It can represent a protected (resilient/reliable) point or\ - \ a protecting (unreliable working or protection) point.\r\n \ - \ The EP replaces the Protection Unit of a traditional protection model.\ - \ \r\n The ForwadingConstruct can be considered as a component\ - \ and the EndPoint as a Port on that component" + \ The EndPoint (EP) object class models the access to the FC function.\ + \ \r\n The traffic forwarding between the associated EPs of the\ + \ FC depends upon the type of FC and may be associated with FcSwitch object\ + \ instances. \r\n In cases where there is resilience the EndPoint\ + \ may convey the resilience role of the access to the FC. \r\n \ + \ It can represent a protected (resilient/reliable) point or a protecting\ + \ (unreliable working or protection) point.\r\n The EP replaces\ + \ the Protection Unit of a traditional protection model. \r\n The\ + \ ForwadingConstruct can be considered as a component and the EndPoint as\ + \ a Port on that component" tapi.connectivity.ConnectivityServiceEndPointRef: allOf: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" @@ -15866,12 +13793,12 @@ definitions: properties: output: $ref: "#/definitions/tapi.connectivity.getconnectivityservicelist.Output" - tapi.connectivity.OwnedNodeEdgePointAugmentation1: + tapi.connectivity.NodeEdgePointAugmentation2: type: "object" properties: cep-list: description: "none" - $ref: "#/definitions/tapi.connectivity.context.topologycontext.topology.node.ownednodeedgepoint.CepList" + $ref: "#/definitions/tapi.connectivity.context.topologycontext.topology.node.nodeedgepoint.CepList" x-augmentation: prefix: "tapi-connectivity" namespace: "urn:onf:otcc:yang:tapi-connectivity" @@ -15890,40 +13817,26 @@ definitions: is-lock-out: type: "boolean" description: "The resource is configured to temporarily not be available for\ - \ use in the protection scheme(s) it is part of.\r\n \ - \ This overrides all other protection control states including forced.\r\ - \n If the item is locked out then it cannot be used under\ - \ any circumstances.\r\n Note: Only relevant when part\ - \ of a protection scheme." + \ use in the protection scheme(s) it is part of.\r\n This\ + \ overrides all other protection control states including forced.\r\n \ + \ If the item is locked out then it cannot be used under any\ + \ circumstances.\r\n Note: Only relevant when part of a protection\ + \ scheme." default: false max-switch-times: type: "integer" format: "int32" description: "Used to limit the maximum swtich times. When work fault disappears\ \ , and traffic return to the original work path, switch counter reset." - restoration-coordinate-type: - description: " The coordination mechanism between multi-layers." - $ref: "#/definitions/tapi.connectivity.CoordinateType" - is-coordinated-switching-both-ends: - type: "boolean" - description: "Is operating such that switching at both ends of each flow acorss\ - \ the FC is coordinated at both ingress and egress ends." - default: false + protection-type: + description: "none" + $ref: "#/definitions/tapi.topology.ProtectionType" hold-off-time: type: "integer" format: "int32" description: "This attribute indicates the time, in milliseconds, between\ \ declaration of signal degrade or signal fail, and the initialization of\ \ the protection switching algorithm." - is-frozen: - type: "boolean" - description: "Temporarily prevents any switch action to be taken and, as such,\ - \ freezes the current state. \r\n Until the freeze is\ - \ cleared, additional near-end external commands are rejected and fault\ - \ condition changes and received APS messages are ignored.\r\n \ - \ All administrative controls of any aspect of protection are\ - \ rejected." - default: false wait-to-revert-time: type: "integer" format: "int32" @@ -15931,9 +13844,9 @@ definitions: \ the time, in minutes, to wait after a fault clears on a higher priority\ \ (preferred) resource before reverting to the preferred resource." default: 15 - resilience-type: - description: "none" - $ref: "#/definitions/tapi.topology.ResilienceType" + selection-control: + description: "Degree of administrative control applied to the switch selection." + $ref: "#/definitions/tapi.connectivity.SelectionControl" preferred-restoration-layer: type: "array" description: "Indicate which layer this resilience parameters package configured\ @@ -15944,6 +13857,28 @@ definitions: type: "integer" format: "int32" description: "none" + restoration-policy: + description: "none" + $ref: "#/definitions/tapi.topology.RestorationPolicy" + restoration-coordinate-type: + description: " The coordination mechanism between multi-layers." + $ref: "#/definitions/tapi.connectivity.CoordinateType" + is-coordinated-switching-both-ends: + type: "boolean" + description: "Is operating such that switching at both ends of each flow acorss\ + \ the FC is coordinated at both ingress and egress ends." + default: false + fault-condition-determination: + type: "string" + description: "none" + is-frozen: + type: "boolean" + description: "Temporarily prevents any switch action to be taken and, as such,\ + \ freezes the current state. \r\n Until the freeze is cleared,\ + \ additional near-end external commands are rejected and fault condition\ + \ changes and received APS messages are ignored.\r\n All\ + \ administrative controls of any aspect of protection are rejected." + default: false reversion-mode: description: "Indcates whether the protection scheme is revertive or non-revertive." $ref: "#/definitions/tapi.connectivity.ReversionMode" @@ -15963,9 +13898,9 @@ definitions: items: $ref: "#/definitions/tapi.connectivity.ConnectionEndPointRef" description: "The FC Route (FcRoute) object class models the individual routes\ - \ of an FC. \r\n The route of an FC object is represented by\ - \ a list of FCs at a lower level. \r\n Note that depending\ - \ on the service supported by an FC, an the FC can have multiple routes." + \ of an FC. \r\n The route of an FC object is represented by a\ + \ list of FCs at a lower level. \r\n Note that depending on the\ + \ service supported by an FC, an the FC can have multiple routes." tapi.connectivity.RouteRef: allOf: - $ref: "#/definitions/tapi.connectivity.ConnectionRef" @@ -16015,9 +13950,6 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.connectivity.RouteRef" - selection-control: - description: "Degree of administrative control applied to the switch selection." - $ref: "#/definitions/tapi.connectivity.SelectionControl" selection-reason: description: "The reason for the current switch selection." $ref: "#/definitions/tapi.connectivity.SelectionReason" @@ -16027,32 +13959,31 @@ definitions: $ref: "#/definitions/tapi.common.PortDirection" description: "The class models the switched forwarding of traffic (traffic flow)\ \ between FcPorts (ConnectionEndPoints) and is present where there is protection\ - \ functionality in the FC (Connection). \r\n If an FC exposes\ - \ protection (having two or more FcPorts that provide alternative identical\ - \ inputs/outputs), the FC will have one or more associated FcSwitch objects\ - \ to represent the alternative flow choices visible at the edge of the FC.\r\ - \n The FC switch represents and defines a protection switch\ - \ structure encapsulated in the FC. \r\n Essentially performs\ - \ one of the functions of the Protection Group in a traditional model. It\ - \ associates to 2 or more FcPorts each playing the role of a Protection Unit.\ - \ \r\n One or more protection, i.e. standby/backup, FcPorts\ - \ provide protection for one or more working (i.e. regular/main/preferred)\ - \ FcPorts where either protection or working can feed one or more protected\ - \ FcPort.\r\n The switch may be used in revertive or non-revertive\ - \ (symmetric) mode. When in revertive mode it may define a waitToRestore time.\r\ - \n It may be used in one of several modes including source\ - \ switch, destination switched, source and destination switched etc (covering\ - \ cases such as 1+1 and 1:1).\r\n It may be locked out (prevented\ - \ from switching), force switched or manual switched.\r\n It\ - \ will indicate switch state and change of state.\r\n The switch\ - \ can be switched away from all sources such that it becomes open and hence\ - \ two coordinated switches can both feed the same LTP so long as at least\ - \ one of the two is switched away from all sources (is 'open').\r\n \ - \ The ability for a Switch to be 'high impedance' allows bidirectional\ - \ ForwardingConstructs to be overlaid on the same bidirectional LTP where\ - \ the appropriate control is enabled to prevent signal conflict.\r\n \ - \ This ability allows multiple alternate routes to be present that\ - \ otherwise would be in conflict." + \ functionality in the FC (Connection). \r\n If an FC exposes protection\ + \ (having two or more FcPorts that provide alternative identical inputs/outputs),\ + \ the FC will have one or more associated FcSwitch objects to represent the\ + \ alternative flow choices visible at the edge of the FC.\r\n The\ + \ FC switch represents and defines a protection switch structure encapsulated\ + \ in the FC. \r\n Essentially performs one of the functions of\ + \ the Protection Group in a traditional model. It associates to 2 or more\ + \ FcPorts each playing the role of a Protection Unit. \r\n One\ + \ or more protection, i.e. standby/backup, FcPorts provide protection for\ + \ one or more working (i.e. regular/main/preferred) FcPorts where either protection\ + \ or working can feed one or more protected FcPort.\r\n The switch\ + \ may be used in revertive or non-revertive (symmetric) mode. When in revertive\ + \ mode it may define a waitToRestore time.\r\n It may be used in\ + \ one of several modes including source switch, destination switched, source\ + \ and destination switched etc (covering cases such as 1+1 and 1:1).\r\n \ + \ It may be locked out (prevented from switching), force switched\ + \ or manual switched.\r\n It will indicate switch state and change\ + \ of state.\r\n The switch can be switched away from all sources\ + \ such that it becomes open and hence two coordinated switches can both feed\ + \ the same LTP so long as at least one of the two is switched away from all\ + \ sources (is 'open').\r\n The ability for a Switch to be 'high\ + \ impedance' allows bidirectional ForwardingConstructs to be overlaid on the\ + \ same bidirectional LTP where the appropriate control is enabled to prevent\ + \ signal conflict.\r\n This ability allows multiple alternate routes\ + \ to be present that otherwise would be in conflict." tapi.connectivity.SwitchControl: allOf: - $ref: "#/definitions/tapi.common.GlobalClass" @@ -16090,9 +14021,50 @@ definitions: tapi.connectivity.ceplist.ConnectionEndPoint: allOf: - $ref: "#/definitions/tapi.connectivity.ConnectionEndPoint" - - $ref: "#/definitions/tapi.oam.ConnectionEndPointAugmentation2" - - $ref: "#/definitions/tapi.odu.ConnectionEndPointAugmentation1" - tapi.connectivity.context.topologycontext.topology.node.ownednodeedgepoint.CepList: + - $ref: "#/definitions/tapi.oam.ConnectionEndPointAugmentation1" + - $ref: "#/definitions/tapi.odu.ConnectionEndPointAugmentation2" + tapi.connectivity.connectivitycontext.ConnectivityService: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + topology-constraint: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + end-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" + resilience-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + connection: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.ConnectionRef" + connectivity-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + direction: + description: "none" + $ref: "#/definitions/tapi.common.ForwardingDirection" + description: "none" + tapi.connectivity.connectivityservice.EndPoint: + allOf: + - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" + - $ref: "#/definitions/tapi.odu.EndPointAugmentation1" + tapi.connectivity.context.topologycontext.topology.node.nodeedgepoint.CepList: allOf: - type: "object" properties: @@ -16106,8 +14078,10 @@ definitions: type: "object" properties: topology-constraint: + type: "array" description: "none" - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" end-point: type: "array" description: "none" @@ -16116,15 +14090,35 @@ definitions: resilience-constraint: description: "none" $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" routing-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.RoutingConstraint" state: - type: "string" description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" connectivity-constraint: description: "none" $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.connectivity.createconnectivityservice.Output: type: "object" properties: @@ -16134,15 +14128,29 @@ definitions: tapi.connectivity.deleteconnectivityservice.Input: type: "object" properties: - service-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.connectivity.getconnectiondetails.Input: type: "object" properties: - connection-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.connectivity.getconnectiondetails.Output: type: "object" properties: @@ -16152,18 +14160,16 @@ definitions: tapi.connectivity.getconnectionendpointdetails.Input: type: "object" properties: - cep-id-or-name: - type: "string" - description: "none" - nep-id-or-name: - type: "string" - description: "none" - node-id-or-name: - type: "string" - description: "none" - topology-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.connectivity.getconnectionendpointdetails.Output: type: "object" properties: @@ -16173,9 +14179,16 @@ definitions: tapi.connectivity.getconnectivityservicedetails.Input: type: "object" properties: - service-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.connectivity.getconnectivityservicedetails.Output: type: "object" properties: @@ -16193,12 +14206,11 @@ definitions: tapi.connectivity.updateconnectivityservice.Input: type: "object" properties: - service-id-or-name: - type: "string" - description: "none" topology-constraint: + type: "array" description: "none" - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" end-point: type: "array" description: "none" @@ -16207,43 +14219,44 @@ definitions: resilience-constraint: description: "none" $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" routing-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.RoutingConstraint" state: - type: "string" description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" connectivity-constraint: description: "none" $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.connectivity.updateconnectivityservice.Output: type: "object" properties: service: description: "none" $ref: "#/definitions/tapi.connectivity.ConnectivityService" - tapi.notification.AlarmInfo: - type: "object" - properties: - perceived-severity: - description: "none" - $ref: "#/definitions/tapi.notification.PerceivedSeverityType" - probable-cause: - type: "string" - description: "none" - service-affecting: - description: "none" - $ref: "#/definitions/tapi.notification.ServiceAffecting" - is-transient: - type: "boolean" - description: "none" - default: false - tapi.notification.ContextAugmentation2: + tapi.notification.ContextAugmentation1: type: "object" properties: notification-context: description: "Augments the base TAPI Context with NotificationService information" - $ref: "#/definitions/tapi.notification.NotificationContext" + $ref: "#/definitions/tapi.notification.context.NotificationContext" x-augmentation: prefix: "tapi-notification" namespace: "urn:onf:otcc:yang:tapi-notification" @@ -16252,11 +14265,6 @@ definitions: properties: output: $ref: "#/definitions/tapi.notification.createnotificationsubscriptionservice.Output" - tapi.notification.DeleteNotificationSubscriptionService: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.notification.deletenotificationsubscriptionservice.Output" tapi.notification.GetNotificationList: type: "object" properties: @@ -16295,8 +14303,8 @@ definitions: - type: "object" properties: target-object-type: + type: "string" description: "none" - $ref: "#/definitions/tapi.notification.ObjectType" additional-text: type: "string" description: "none" @@ -16312,18 +14320,15 @@ definitions: type: "integer" format: "int32" description: "A monotonous increasing sequence number associated with the\ - \ notification.\r\n The exact semantics of how this\ - \ sequence number is assigned (per channel or subscription or source or\ - \ system) is left undefined." - tca-info: - description: "none" - $ref: "#/definitions/tapi.notification.TcaInfo" + \ notification.\r\n The exact semantics of how this sequence\ + \ number is assigned (per channel or subscription or source or system)\ + \ is left undefined." target-object-identifier: type: "string" description: "none" notification-type: + type: "string" description: "none" - $ref: "#/definitions/tapi.notification.NotificationType" target-object-name: type: "array" description: "none" @@ -16335,9 +14340,9 @@ definitions: source-indicator: description: "none" $ref: "#/definitions/tapi.notification.SourceIndicator" - alarm-info: + layer-protocol-qualifier: + type: "string" description: "none" - $ref: "#/definitions/tapi.notification.AlarmInfo" changed-attributes: type: "array" description: "none" @@ -16357,23 +14362,10 @@ definitions: stream-address: type: "string" description: "The address/location/URI of the channel/stream to which the\ - \ subscribed notifications are published.\r\n This\ - \ specifics of this is typically dependent on the implementation protocol\ - \ & mechanism and hence is typed as a string." + \ subscribed notifications are published.\r\n This specifics\ + \ of this is typically dependent on the implementation protocol & mechanism\ + \ and hence is typed as a string." description: "none" - tapi.notification.NotificationContext: - type: "object" - properties: - notif-subscription: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - notification: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.Notification" tapi.notification.NotificationSubscriptionService: allOf: - $ref: "#/definitions/tapi.common.GlobalClass" @@ -16394,68 +14386,16 @@ definitions: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.ObjectType" + type: "string" supported-notification-types: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.NotificationType" + type: "string" subscription-filter: description: "none" $ref: "#/definitions/tapi.notification.SubscriptionFilter" description: "none" - tapi.notification.NotificationType: - type: "string" - enum: - - "OBJECT_CREATION" - - "OBJECT_DELETION" - - "ATTRIBUTE_VALUE_CHANGE" - - "ALARM_EVENT" - - "THRESHOLD_CROSSING_ALERT" - tapi.notification.ObjectType: - type: "string" - enum: - - "TOPOLOGY" - - "NODE" - - "LINK" - - "CONNECTION" - - "PATH" - - "CONNECTIVITY_SERVICE" - - "VIRTUAL_NETWORK_SERVICE" - - "PATH_COMPUTATION_SERVICE" - - "NODE_EDGE_POINT" - - "SERVICE_INTERFACE_POINT" - - "CONNECTION_END_POINT" - - "MAINTENANCE_ENTITY_GROUP" - - "MAINTENANCE_ENTITY" - - "MEG_END_POINT" - - "MEG_INTERMEDIATE_POINT" - - "SWITCH_CONTROL" - - "SWITCH" - - "ROUTE" - - "NODE_RULE_GROUP" - - "INTER_RULE_GROUP" - - "RULE" - - "OAM_JOB" - tapi.notification.PerceivedSeverityType: - type: "string" - enum: - - "CRITICAL" - - "MAJOR" - - "MINOR" - - "WARNING" - - "CLEARED" - tapi.notification.PerceivedTcaSeverity: - type: "string" - enum: - - "WARNING" - - "CLEAR" - tapi.notification.ServiceAffecting: - type: "string" - enum: - - "SERVICE_AFFECTING" - - "NOT_SERVICE_AFFECTING" - - "UNKNOWN" tapi.notification.SourceIndicator: type: "string" enum: @@ -16471,7 +14411,7 @@ definitions: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.NotificationType" + type: "string" requested-object-identifier: type: "array" description: "none" @@ -16492,57 +14432,56 @@ definitions: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.ObjectType" + type: "string" description: "none" tapi.notification.SubscriptionState: type: "string" enum: - "SUSPENDED" - "ACTIVE" - tapi.notification.TcaInfo: - type: "object" - properties: - threshold-crossing: - description: "none" - $ref: "#/definitions/tapi.notification.ThresholdCrossingType" - threshold-parameter: - type: "string" - description: "none" - is-transient: - type: "boolean" - description: "none" - default: false - threshold-value: - type: "integer" - format: "int32" - description: "none" - perceived-severity: - description: "none" - $ref: "#/definitions/tapi.notification.PerceivedTcaSeverity" - suspect-interval-flag: - type: "boolean" - description: "none" - default: false - measurement-interval: - type: "string" - description: "none" - tapi.notification.ThresholdCrossingType: - type: "string" - enum: - - "THRESHOLD_ABOVE" - - "THRESHOLD_BELOW" - - "CLEARED" tapi.notification.UpdateNotificationSubscriptionService: type: "object" properties: output: $ref: "#/definitions/tapi.notification.updatenotificationsubscriptionservice.Output" + tapi.notification.context.NotificationContext: + allOf: + - type: "object" + properties: + notif-subscription: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + notification: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.notificationcontext.Notification" + description: "Augments the base TAPI Context with NotificationService information" tapi.notification.createnotificationsubscriptionservice.Input: type: "object" properties: subscription-state: description: "none" $ref: "#/definitions/tapi.notification.SubscriptionState" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" subscription-filter: description: "none" $ref: "#/definitions/tapi.notification.SubscriptionFilter" @@ -16555,24 +14494,33 @@ definitions: tapi.notification.deletenotificationsubscriptionservice.Input: type: "object" properties: - subscription-id-or-name: + uuid: type: "string" - description: "none" - tapi.notification.deletenotificationsubscriptionservice.Output: - type: "object" - properties: - subscription-service: - description: "none" - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.notification.getnotificationlist.Input: type: "object" properties: - time-period: - type: "string" - description: "none" - subscription-id-or-name: - type: "string" + time-range: description: "none" + $ref: "#/definitions/tapi.common.TimeRange" + subscription-id: + type: "string" + description: "UUID of the associated Notification Subscription Service: An\ + \ identifier that is universally unique within an identifier space, where\ + \ the identifier space is itself globally unique, and immutable.\r\n \ + \ An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.notification.getnotificationlist.Output: type: "object" properties: @@ -16580,13 +14528,20 @@ definitions: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.Notification" + $ref: "#/definitions/tapi.notification.notificationcontext.Notification" tapi.notification.getnotificationsubscriptionservicedetails.Input: type: "object" properties: - subscription-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.notification.getnotificationsubscriptionservicedetails.Output: type: "object" properties: @@ -16608,31 +14563,66 @@ definitions: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.ObjectType" + type: "string" supported-notification-types: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.NotificationType" + type: "string" + tapi.notification.notificationcontext.Notification: + allOf: + - $ref: "#/definitions/tapi.notification.Notification" + - $ref: "#/definitions/tapi.oam.NotificationAugmentation1" + - $ref: "#/definitions/tapi.oam.NotificationAugmentation2" tapi.notification.updatenotificationsubscriptionservice.Input: type: "object" properties: subscription-state: description: "none" $ref: "#/definitions/tapi.notification.SubscriptionState" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" subscription-filter: description: "none" $ref: "#/definitions/tapi.notification.SubscriptionFilter" - subscription-id-or-name: - type: "string" - description: "none" tapi.notification.updatenotificationsubscriptionservice.Output: type: "object" properties: subscription-service: description: "none" $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - tapi.oam.ConnectionEndPointAugmentation2: + tapi.oam.AlarmInfo: + type: "object" + properties: + perceived-severity: + description: "none" + $ref: "#/definitions/tapi.oam.PerceivedSeverityType" + probable-cause: + type: "string" + description: "none" + service-affecting: + description: "none" + $ref: "#/definitions/tapi.oam.ServiceAffecting" + is-transient: + type: "boolean" + description: "none" + default: false + tapi.oam.ConnectionEndPointAugmentation1: type: "object" properties: mep-mip-list: @@ -16641,12 +14631,12 @@ definitions: x-augmentation: prefix: "tapi-oam" namespace: "urn:onf:otcc:yang:tapi-oam" - tapi.oam.ContextAugmentation1: + tapi.oam.ContextAugmentation3: type: "object" properties: oam-context: description: "Augments the base TAPI Context with OamService information" - $ref: "#/definitions/tapi.oam.OamContext" + $ref: "#/definitions/tapi.oam.context.OamContext" x-augmentation: prefix: "tapi-oam" namespace: "urn:onf:otcc:yang:tapi-oam" @@ -16655,16 +14645,47 @@ definitions: properties: output: $ref: "#/definitions/tapi.oam.createoamjob.Output" + tapi.oam.CreateOamProfile: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.createoamprofile.Output" tapi.oam.CreateOamService: type: "object" properties: output: $ref: "#/definitions/tapi.oam.createoamservice.Output" - tapi.oam.CreateOamServiceEndPoint: + tapi.oam.CreateOamServicePoint: type: "object" properties: output: - $ref: "#/definitions/tapi.oam.createoamserviceendpoint.Output" + $ref: "#/definitions/tapi.oam.createoamservicepoint.Output" + tapi.oam.CurrentData: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + elapsed-time: + description: "none" + $ref: "#/definitions/tapi.common.TimeInterval" + period-start-time: + type: "string" + description: "This attribute indicates the start of the current monitoring\ + \ interval.\r\n The value is bound to the quarter of an\ + \ hour in case of a 15 minute interval and bound to the hour in case of\ + \ a 24 hour interval." + pm-data-pac: + description: "none" + $ref: "#/definitions/tapi.oam.PmDataPac" + history-data: + type: "array" + description: "in case of 24hr Current Data, at least 1 History Data.\r\n\ + \ In case of 15min Current Data, at least 16 History Data.\r\ + \n In case of <15min, the number of History Data shall\ + \ be able to cover a span of 4 hours." + items: + $ref: "#/definitions/tapi.oam.HistoryData" + description: "none" tapi.oam.GetMeg: type: "object" properties: @@ -16675,53 +14696,75 @@ definitions: properties: output: $ref: "#/definitions/tapi.oam.getoamjob.Output" - tapi.oam.GetOamService: + tapi.oam.GetOamJobList: type: "object" properties: output: - $ref: "#/definitions/tapi.oam.getoamservice.Output" - tapi.oam.GetOamServiceEndPoint: + $ref: "#/definitions/tapi.oam.getoamjoblist.Output" + tapi.oam.GetOamProfile: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getoamprofile.Output" + tapi.oam.GetOamProfileList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getoamprofilelist.Output" + tapi.oam.GetOamService: type: "object" properties: output: - $ref: "#/definitions/tapi.oam.getoamserviceendpoint.Output" + $ref: "#/definitions/tapi.oam.getoamservice.Output" tapi.oam.GetOamServiceList: type: "object" properties: output: $ref: "#/definitions/tapi.oam.getoamservicelist.Output" - tapi.oam.Meg: + tapi.oam.GetOamServicePoint: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getoamservicepoint.Output" + tapi.oam.HistoryData: allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.common.OperationalStatePac" + - $ref: "#/definitions/tapi.common.LocalClass" - type: "object" properties: - meg-identifier: + period-start-time: type: "string" + description: "This attribute indicates the start of the monitoring interval.\r\ + \n The value is bound to the quarter of an hour in case\ + \ of a 15 minute interval and bound to the hour in case of a 24 hour interval." + pm-data-pac: description: "none" - meg-level: - type: "integer" - format: "int32" + $ref: "#/definitions/tapi.oam.PmDataPac" + period-end-time: + type: "string" description: "none" - mip: - type: "array" - description: "ME may 0, 1, or more MIPs" - items: - $ref: "#/definitions/tapi.oam.Mip" + description: "none" + tapi.oam.Meg: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.common.OperationalStatePac" + - type: "object" + properties: layer-protocol-name: description: "none" $ref: "#/definitions/tapi.common.LayerProtocolName" mep: type: "array" description: "1. ME may have 0 MEPs (case of transit domains where at least\ - \ 1 MIP is present)\r\n 2. ME may have 1 MEP (case\ - \ of edge domaind, where the peer MEP is ouside the managed domain)\r\n\ - \ 3. ME may have 2 MEPs" + \ 1 MIP is present)\r\n 2. ME may have 1 MEP (case of edge\ + \ domaind, where the peer MEP is ouside the managed domain)\r\n \ + \ 3. ME may have 2 MEPs" items: $ref: "#/definitions/tapi.oam.Mep" - direction: - description: "none" - $ref: "#/definitions/tapi.common.ForwardingDirection" + mip: + type: "array" + description: "ME may 0, 1, or more MIPs" + items: + $ref: "#/definitions/tapi.oam.Mip" description: "none" tapi.oam.MegRef: type: "object" @@ -16739,17 +14782,6 @@ definitions: layer-protocol-name: description: "none" $ref: "#/definitions/tapi.common.LayerProtocolName" - peer-mep-identifier: - type: "array" - description: "none" - items: - type: "string" - mep-identifier: - type: "string" - description: "none" - direction: - description: "none" - $ref: "#/definitions/tapi.common.TerminationDirection" description: "none" tapi.oam.MepMipList: type: "object" @@ -16793,42 +14825,24 @@ definitions: description: "none" x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:meg/tapi-oam:mip/tapi-oam:local-id" description: "none" - tapi.oam.OamConstraint: - type: "object" - properties: - layer-protocol-name: - description: "none" - $ref: "#/definitions/tapi.common.LayerProtocolName" - meg-level: - type: "integer" - format: "int32" - description: "none" - direction: - description: "none" - $ref: "#/definitions/tapi.common.ForwardingDirection" - tapi.oam.OamContext: + tapi.oam.NotificationAugmentation1: type: "object" properties: - oam-service: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamService" - oam-profile: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamProfile" - oam-job: - type: "array" + tca-info: description: "none" - items: - $ref: "#/definitions/tapi.oam.OamJob" - meg: - type: "array" + $ref: "#/definitions/tapi.oam.TcaInfo" + x-augmentation: + prefix: "tapi-oam" + namespace: "urn:onf:otcc:yang:tapi-oam" + tapi.oam.NotificationAugmentation2: + type: "object" + properties: + alarm-info: description: "none" - items: - $ref: "#/definitions/tapi.oam.Meg" + $ref: "#/definitions/tapi.oam.AlarmInfo" + x-augmentation: + prefix: "tapi-oam" + namespace: "urn:onf:otcc:yang:tapi-oam" tapi.oam.OamJob: allOf: - $ref: "#/definitions/tapi.common.AdminStatePac" @@ -16841,27 +14855,34 @@ definitions: oam-profile: description: "none" $ref: "#/definitions/tapi.oam.OamProfileRef" - pm-current-data: - type: "array" - description: "Granularity period of the CurrentData identifies the specific\ - \ CurrentData instance in the scope of this OamJob.\r\n \ - \ For example, typically at least\r\n one 15min\ - \ and\r\n one 24hr;\r\n optionally\ - \ one additional configurable (< 15min)" - items: - $ref: "#/definitions/tapi.oam.PmCurrentData" creation-time: type: "string" description: "none" - oam-service-end-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamServiceEndPointRef" oam-job-type: type: "string" description: "none" + oam-service-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamServicePointRef" + current-data: + type: "array" + description: "Granularity period of the CurrentData identifies the specific\ + \ CurrentData instance in the scope of this OamJob.\r\n \ + \ For example, typically at least\r\n one 15min and\r\n\ + \ one 24hr;\r\n optionally one additional\ + \ configurable (< 15min)" + items: + $ref: "#/definitions/tapi.oam.CurrentData" description: "none" + tapi.oam.OamJobRef: + type: "object" + properties: + oam-job-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-job/tapi-oam:uuid" tapi.oam.OamProfile: allOf: - $ref: "#/definitions/tapi.common.GlobalClass" @@ -16872,11 +14893,6 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.oam.PmThresholdData" - pm-bin-data: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.PmBinData" description: "none" tapi.oam.OamProfileRef: type: "object" @@ -16889,37 +14905,26 @@ definitions: allOf: - $ref: "#/definitions/tapi.common.AdminStatePac" - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.oam.OamConstraint" - type: "object" properties: - oam-profile: + layer-protocol-name: description: "none" - $ref: "#/definitions/tapi.oam.OamProfileRef" - end-point: + $ref: "#/definitions/tapi.common.LayerProtocolName" + oam-service-point: type: "array" description: "none" items: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" + $ref: "#/definitions/tapi.oam.OamServicePoint" meg: description: "none" $ref: "#/definitions/tapi.oam.MegRef" description: "none" - tapi.oam.OamServiceEndPoint: + tapi.oam.OamServicePoint: allOf: - $ref: "#/definitions/tapi.common.AdminStatePac" - $ref: "#/definitions/tapi.common.LocalClass" - type: "object" properties: - peer-mep-identifier: - type: "array" - description: "This attribute models the MI_PeerMEP_ID[i] defined in G.8021\ - \ and configured as specified in G.8051. It provides the identifiers of\ - \ the MEPs which are peer to the subject MEP.\r\n This\ - \ attribute is not specified in case the OSEP relates to the provisioing\ - \ of an MIP.\r\n In case of P2P, there is only one\ - \ peer" - items: - type: "string" connectivity-service-end-point: description: "none" $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" @@ -16929,30 +14934,27 @@ definitions: service-interface-point: description: "none" $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + is-mip: + type: "boolean" + description: "If true, the object is related to a MIP.\r\n \ + \ If false, the object is related to a MEP." + default: false layer-protocol-name: description: "none" $ref: "#/definitions/tapi.common.LayerProtocolName" mep: description: "none" $ref: "#/definitions/tapi.oam.MepRef" - mep-identifier: - type: "string" - description: "This attribute contains the identifier of the MEP.\r\n \ - \ This attribute is empty in case the OSEP relates to\ - \ the provisioing of an MIP.\r\n " - direction: - description: "none" - $ref: "#/definitions/tapi.common.PortDirection" description: "none" - tapi.oam.OamServiceEndPointRef: + tapi.oam.OamServicePointRef: allOf: - $ref: "#/definitions/tapi.oam.OamServiceRef" - type: "object" properties: - oam-service-end-point-local-id: + oam-service-point-local-id: type: "string" description: "none" - x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-service/tapi-oam:end-point/tapi-oam:local-id" + x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-service/tapi-oam:oam-service-point/tapi-oam:local-id" description: "none" tapi.oam.OamServiceRef: type: "object" @@ -16961,7 +14963,49 @@ definitions: type: "string" description: "none" x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-service/tapi-oam:uuid" - tapi.oam.PmBinData: + tapi.oam.PerceivedSeverityType: + type: "string" + enum: + - "CRITICAL" + - "MAJOR" + - "MINOR" + - "WARNING" + - "CLEARED" + tapi.oam.PerceivedTcaSeverity: + type: "string" + enum: + - "WARNING" + - "CLEAR" + tapi.oam.PmDataPac: + type: "object" + properties: + suspect-interval-flag: + type: "boolean" + description: "This attribute is used to indicate that the performance data\ + \ for the current period may not be reliable. Some reasons for this to occur\ + \ are:\r\n Suspect data were detected by the actual resource\ + \ doing data collection.\r\n Transition of the administrativeState\ + \ attribute to/from the 'lock' state.\r\n Transition of\ + \ the operationalState to/from the 'disabled' state.\r\n \ + \ Scheduler setting that inhibits the collection function.\r\n \ + \ The performance counters were reset during the interval.\r\n\ + \ The currentData (or subclass) object instance was created\ + \ during the monitoring period." + default: false + granularity-period: + description: "none" + $ref: "#/definitions/tapi.common.TimePeriod" + tapi.oam.PmParameterValue: + type: "object" + properties: + pm-parameter-int-value: + type: "integer" + format: "int32" + description: "none" + pm-parameter-real-value: + type: "string" + description: "none" + tapi.oam.PmThresholdData: allOf: - $ref: "#/definitions/tapi.common.LocalClass" - type: "object" @@ -16969,199 +15013,393 @@ definitions: granularity-period: description: "none" $ref: "#/definitions/tapi.common.TimePeriod" - description: "none" - tapi.oam.PmCurrentData: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - elapsed-time: - description: "none" - $ref: "#/definitions/tapi.common.TimeInterval" - pm-history-data: + threshold-parameter: type: "array" - description: "in case of 24hr Current Data, at least 1 History Data.\r\n\ - \ In case of 15min Current Data, at least 16 History\ - \ Data.\r\n In case of <15min, the number of History\ - \ Data shall be able to cover a span of 4 hours." - items: - $ref: "#/definitions/tapi.oam.PmHistoryData" - granularity-period: - description: "none" - $ref: "#/definitions/tapi.common.TimePeriod" - suspect-interval-flag: - type: "boolean" - description: "This attribute is used to indicate that the performance data\ - \ for the current period may not be reliable. Some reasons for this to\ - \ occur are:\r\n Suspect data were detected by the\ - \ actual resource doing data collection.\r\n Transition\ - \ of the administrativeState attribute to/from the 'lock' state.\r\n \ - \ Transition of the operationalState to/from the 'disabled'\ - \ state.\r\n Scheduler setting that inhibits the\ - \ collection function.\r\n The performance counters\ - \ were reset during the interval.\r\n The currentData\ - \ (or subclass) object instance was created during the monitoring period." - default: false - timestamp: - type: "string" - description: "This attribute indicates the start of the current monitoring\ - \ interval.\r\n The value is bound to the quarter of\ - \ an hour in case of a 15 minute interval and bound to the hour in case\ - \ of a 24 hour interval." - description: "none" - tapi.oam.PmHistoryData: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - granularity-period: - description: "none" - $ref: "#/definitions/tapi.common.TimePeriod" - period-end-time: - type: "string" description: "none" - suspect-interval-flag: - type: "boolean" - description: "This attribute indicates that the performance data may not\ - \ be reliable." - default: false - description: "none" - tapi.oam.PmThresholdData: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: + items: + $ref: "#/definitions/tapi.oam.ThresholdParameter" is-transient: type: "boolean" description: "none" default: false - granularity-period: - description: "none" - $ref: "#/definitions/tapi.common.TimePeriod" + applicable-job-type: + type: "array" + description: "This attribute allows an PMThresholdData instance to be constrained\ + \ to specific job types. If an PMThresholdData instance is so configured\ + \ to be applicable to more than one job type (worst case ALL), only the\ + \ parameters relevant for the job instance will be used (non-applicable\ + \ profile parameters will be ignored)" + items: + type: "string" description: "none" + tapi.oam.ServiceAffecting: + type: "string" + enum: + - "SERVICE_AFFECTING" + - "NOT_SERVICE_AFFECTING" + - "UNKNOWN" + tapi.oam.TcaInfo: + type: "object" + properties: + oam-job: + description: "MEF 35.1\r\n Identification of the PM Session\ + \ for which the TCA Function was configured." + $ref: "#/definitions/tapi.oam.OamJobRef" + threshold-parameter: + description: "none" + $ref: "#/definitions/tapi.oam.ThresholdParameter" + is-transient: + type: "boolean" + description: "none" + default: false + perceived-severity: + description: "none" + $ref: "#/definitions/tapi.oam.PerceivedTcaSeverity" + suspect-interval-flag: + type: "boolean" + description: "none" + default: false + measurement-interval: + type: "string" + description: "none" + tapi.oam.ThresholdCrossingQualifier: + type: "string" + enum: + - "NOT_APPLICABLE" + - "NEAR_END" + - "FAR_END" + - "BIDIRECTIONAL" + - "FORWARD" + - "BACKWARD" + tapi.oam.ThresholdParameter: + type: "object" + properties: + pm-parameter-below-thrs: + description: "none" + $ref: "#/definitions/tapi.oam.PmParameterValue" + pm-parameter-clear-thrs: + description: "none" + $ref: "#/definitions/tapi.oam.PmParameterValue" + pm-parameter-above-thrs: + description: "none" + $ref: "#/definitions/tapi.oam.PmParameterValue" + pm-parameter-name: + type: "string" + description: "none" + threshold-location: + description: "none" + $ref: "#/definitions/tapi.oam.ThresholdCrossingQualifier" tapi.oam.UpdateOamJob: type: "object" properties: output: $ref: "#/definitions/tapi.oam.updateoamjob.Output" + tapi.oam.UpdateOamProfile: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.updateoamprofile.Output" tapi.oam.UpdateOamService: type: "object" properties: output: $ref: "#/definitions/tapi.oam.updateoamservice.Output" - tapi.oam.UpdateOamServiceEndPoint: + tapi.oam.UpdateOamServicePoint: type: "object" properties: output: - $ref: "#/definitions/tapi.oam.updateoamserviceendpoint.Output" + $ref: "#/definitions/tapi.oam.updateoamservicepoint.Output" + tapi.oam.context.OamContext: + allOf: + - type: "object" + properties: + oam-service: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamService" + oam-profile: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamProfile" + oam-job: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamJob" + meg: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.oamcontext.Meg" + description: "Augments the base TAPI Context with OamService information" tapi.oam.createoamjob.Input: type: "object" properties: schedule: - type: "string" description: "none" - oam-service-end-point: + $ref: "#/definitions/tapi.common.TimeRange" + name: type: "array" - description: "none" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." items: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" + $ref: "#/definitions/tapi.common.NameAndValue" + oam-service-point-id: + type: "string" + description: "UUID of the associated OSEPs: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" oam-job-type: type: "string" description: "none" - oam-profile: - description: "none" - $ref: "#/definitions/tapi.oam.OamProfile" state: - type: "string" description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + oam-profile-id: + type: "string" + description: "UUID of the OamProfile to be applied: An identifier that is\ + \ universally unique within an identifier space, where the identifier space\ + \ is itself globally unique, and immutable.\r\n An UUID\ + \ carries no semantics with respect to the purpose or state of the entity.\r\ + \n UUID here uses string representation as defined in\ + \ RFC 4122. The canonical representation uses lowercase characters.\r\n\ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + oam-service-id: + type: "string" + description: "UUID of the associated OamService: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.oam.createoamjob.Output: type: "object" properties: oam-job: description: "none" $ref: "#/definitions/tapi.oam.OamJob" - tapi.oam.createoamservice.Input: + tapi.oam.createoamprofile.Input: type: "object" properties: - oam-constraint: - description: "none" - $ref: "#/definitions/tapi.oam.OamConstraint" - state: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: type: "string" - description: "none" - end-point: + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + pm-threshold-data: type: "array" description: "none" items: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - tapi.oam.createoamservice.Output: + $ref: "#/definitions/tapi.oam.PmThresholdData" + tapi.oam.createoamprofile.Output: type: "object" properties: - service: + oam-profile: description: "none" - $ref: "#/definitions/tapi.oam.OamService" - tapi.oam.createoamserviceendpoint.Input: + $ref: "#/definitions/tapi.oam.OamProfile" + tapi.oam.createoamservice.Input: type: "object" properties: - peer-mep-identifier: - type: "array" + layer-protocol-name: description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." items: - type: "string" - service-id: - type: "string" + $ref: "#/definitions/tapi.common.NameAndValue" + oam-service-point: + type: "array" description: "none" - sip-id: - type: "string" + items: + $ref: "#/definitions/tapi.oam.OamServicePoint" + state: description: "none" - c-sep-id: + $ref: "#/definitions/tapi.common.AdministrativeState" + uuid: type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.createoamservice.Output: + type: "object" + properties: + oam-service: description: "none" - mep-identifier: - type: "string" + $ref: "#/definitions/tapi.oam.OamService" + tapi.oam.createoamservicepoint.Input: + type: "object" + properties: + layer-protocol-name: description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" state: - type: "string" - description: "none" - layer: - type: "string" description: "none" - direction: + $ref: "#/definitions/tapi.common.AdministrativeState" + connectivity-service-end-point-id: + type: "string" + description: "UUID of the CSEP to be monitored: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + service-interface-point-id: + type: "string" + description: "UUID of the associated SIP to be monitored: An identifier that\ + \ is universally unique within an identifier space, where the identifier\ + \ space is itself globally unique, and immutable.\r\n \ + \ An UUID carries no semantics with respect to the purpose or state of\ + \ the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + oam-service-id: + type: "string" + description: "UUID of the parent OamService: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + uuid: type: "string" - description: "none" - tapi.oam.createoamserviceendpoint.Output: + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.createoamservicepoint.Output: type: "object" properties: - end-point: + oam-service-point: description: "none" - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" + $ref: "#/definitions/tapi.oam.OamServicePoint" tapi.oam.deleteoamjob.Input: type: "object" properties: - job-id: + uuid: type: "string" - description: "none" - tapi.oam.deleteoamservice.Input: + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.deleteoamprofile.Input: type: "object" properties: - service-id: + uuid: type: "string" - description: "none" - tapi.oam.deleteoamserviceendpoint.Input: + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.deleteoamservice.Input: type: "object" properties: - service-id: + uuid: type: "string" - description: "none" - o-sep-id: + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.deleteoamservicepoint.Input: + type: "object" + properties: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.oam.getmeg.Input: type: "object" properties: - service-id: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.oam.getmeg.Output: type: "object" properties: @@ -17171,50 +15409,103 @@ definitions: tapi.oam.getoamjob.Input: type: "object" properties: - job-id: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.oam.getoamjob.Output: type: "object" properties: oam-job: description: "none" $ref: "#/definitions/tapi.oam.OamJob" - tapi.oam.getoamservice.Input: + tapi.oam.getoamjoblist.Output: type: "object" properties: - service-id: - type: "string" + oam-job: + type: "array" description: "none" - tapi.oam.getoamservice.Output: + items: + $ref: "#/definitions/tapi.oam.OamJob" + tapi.oam.getoamprofile.Input: type: "object" properties: - service: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.getoamprofile.Output: + type: "object" + properties: + oam-profile: description: "none" - $ref: "#/definitions/tapi.oam.OamService" - tapi.oam.getoamserviceendpoint.Input: + $ref: "#/definitions/tapi.oam.OamProfile" + tapi.oam.getoamprofilelist.Output: type: "object" properties: - service-id: - type: "string" + oam-profile: + type: "array" description: "none" - o-sep-id: + items: + $ref: "#/definitions/tapi.oam.OamProfile" + tapi.oam.getoamservice.Input: + type: "object" + properties: + uuid: type: "string" - description: "none" - tapi.oam.getoamserviceendpoint.Output: + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.getoamservice.Output: type: "object" properties: - end-point: + oam-service: description: "none" - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" + $ref: "#/definitions/tapi.oam.OamService" tapi.oam.getoamservicelist.Output: type: "object" properties: - service: + oam-service: type: "array" description: "none" items: $ref: "#/definitions/tapi.oam.OamService" + tapi.oam.getoamservicepoint.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.getoamservicepoint.Output: + type: "object" + properties: + oam-service-point: + description: "none" + $ref: "#/definitions/tapi.oam.OamServicePoint" tapi.oam.meg.Mep: allOf: - $ref: "#/definitions/tapi.oam.Mep" @@ -17227,98 +15518,164 @@ definitions: allOf: - $ref: "#/definitions/tapi.common.GlobalClass" - $ref: "#/definitions/tapi.common.OperationalStatePac" + - $ref: "#/definitions/tapi.odu.MegAugmentation1" - type: "object" properties: - meg-identifier: - type: "string" - description: "none" - meg-level: - type: "integer" - format: "int32" - description: "none" - mip: - type: "array" - description: "ME may 0, 1, or more MIPs" - items: - $ref: "#/definitions/tapi.oam.meg.Mip" layer-protocol-name: description: "none" $ref: "#/definitions/tapi.common.LayerProtocolName" mep: type: "array" description: "1. ME may have 0 MEPs (case of transit domains where at least\ - \ 1 MIP is present)\r\n 2. ME may have 1 MEP (case\ - \ of edge domaind, where the peer MEP is ouside the managed domain)\r\n\ - \ 3. ME may have 2 MEPs" + \ 1 MIP is present)\r\n 2. ME may have 1 MEP (case of edge\ + \ domaind, where the peer MEP is ouside the managed domain)\r\n \ + \ 3. ME may have 2 MEPs" items: $ref: "#/definitions/tapi.oam.meg.Mep" - direction: - description: "none" - $ref: "#/definitions/tapi.common.ForwardingDirection" + mip: + type: "array" + description: "ME may 0, 1, or more MIPs" + items: + $ref: "#/definitions/tapi.oam.meg.Mip" description: "none" tapi.oam.updateoamjob.Input: type: "object" properties: - job-id: - type: "string" - description: "none" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" schedule: - type: "string" - description: "none" - oam-profile: description: "none" - $ref: "#/definitions/tapi.oam.OamProfile" + $ref: "#/definitions/tapi.common.TimeRange" state: - type: "string" description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + oam-profile-id: + type: "string" + description: "UUID of the OamProfile to be applied: An identifier that is\ + \ universally unique within an identifier space, where the identifier space\ + \ is itself globally unique, and immutable.\r\n An UUID\ + \ carries no semantics with respect to the purpose or state of the entity.\r\ + \n UUID here uses string representation as defined in\ + \ RFC 4122. The canonical representation uses lowercase characters.\r\n\ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.oam.updateoamjob.Output: type: "object" properties: oam-job: description: "none" $ref: "#/definitions/tapi.oam.OamJob" - tapi.oam.updateoamservice.Input: + tapi.oam.updateoamprofile.Input: type: "object" properties: - oam-constraint: - description: "none" - $ref: "#/definitions/tapi.oam.OamConstraint" - service-id: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + pm-threshold-data: + type: "array" description: "none" - state: - type: "string" + items: + $ref: "#/definitions/tapi.oam.PmThresholdData" + tapi.oam.updateoamprofile.Output: + type: "object" + properties: + oam-profile: description: "none" - end-point: + $ref: "#/definitions/tapi.oam.OamProfile" + tapi.oam.updateoamservice.Input: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + oam-service-point: type: "array" description: "none" items: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" + $ref: "#/definitions/tapi.oam.OamServicePoint" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.oam.updateoamservice.Output: type: "object" properties: - service: + oam-service: description: "none" $ref: "#/definitions/tapi.oam.OamService" - tapi.oam.updateoamserviceendpoint.Input: + tapi.oam.updateoamservicepoint.Input: type: "object" properties: - service-id: - type: "string" - description: "none" - o-sep-id: - type: "string" - description: "none" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" state: - type: "string" description: "none" - tapi.oam.updateoamserviceendpoint.Output: + $ref: "#/definitions/tapi.common.AdministrativeState" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.updateoamservicepoint.Output: type: "object" properties: - end-point: + oam-service-point: description: "none" - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - tapi.odu.ConnectionEndPointAugmentation1: + $ref: "#/definitions/tapi.oam.OamServicePoint" + tapi.odu.ConnectionEndPointAugmentation2: type: "object" properties: odu-connection-end-point-spec: @@ -17345,6 +15702,15 @@ definitions: enum: - "PERCENTAGE" - "NUMBER_ERRORED_BLOCKS" + tapi.odu.EndPointAugmentation1: + type: "object" + properties: + odu-connectivity-service-end-point-spec: + description: "none" + $ref: "#/definitions/tapi.odu.OduConnectivityServiceEndPointSpec" + x-augmentation: + prefix: "tapi-odu" + namespace: "urn:onf:otcc:yang:tapi-odu" tapi.odu.MappingType: type: "string" enum: @@ -17354,12 +15720,21 @@ definitions: - "GMP" - "TTP_GFP_BMP" - "NULL" + tapi.odu.MegAugmentation1: + type: "object" + properties: + odu-meg-spec: + description: "none" + $ref: "#/definitions/tapi.odu.OduMegSpec" + x-augmentation: + prefix: "tapi-odu" + namespace: "urn:onf:otcc:yang:tapi-odu" tapi.odu.MepAugmentation1: type: "object" properties: - odu-connection-end-point-spec: + odu-mep-spec: description: "none" - $ref: "#/definitions/tapi.odu.OduConnectionEndPointSpec" + $ref: "#/definitions/tapi.odu.OduMepSpec" x-augmentation: prefix: "tapi-odu" namespace: "urn:onf:otcc:yang:tapi-odu" @@ -17372,6 +15747,16 @@ definitions: x-augmentation: prefix: "tapi-odu" namespace: "urn:onf:otcc:yang:tapi-odu" + tapi.odu.NodeEdgePointAugmentation1: + type: "object" + properties: + odu-node-edge-point-spec: + description: "Augments the base LayerProtocol information in NodeEdgePoint\ + \ with ODU-specific information" + $ref: "#/definitions/tapi.odu.OduNodeEdgePointSpec" + x-augmentation: + prefix: "tapi-odu" + namespace: "urn:onf:otcc:yang:tapi-odu" tapi.odu.OduCommonPac: type: "object" properties: @@ -17379,35 +15764,90 @@ definitions: type: "integer" format: "int32" description: "This attribute indicates the rate tolerance of the ODU termination\ - \ point. \r\n Valid values are real value in the unit\ - \ of ppm. \r\n Standardized values are defined in Table\ - \ 7-2/G.709." + \ point. \r\n Valid values are real value in the unit of\ + \ ppm. \r\n Standardized values are defined in Table 7-2/G.709." odu-rate: type: "integer" format: "int32" description: "This attribute indicates the rate of the ODU terminatino point.\ - \ \r\n This attribute is Set at create; i.e., once created\ - \ it cannot be changed directly. \r\n In case of resizable\ + \ \r\n This attribute is Set at create; i.e., once created\ + \ it cannot be changed directly. \r\n In case of resizable\ \ ODU flex, its value can be changed via HAO (not directly on the attribute).\ - \ \r\n " + \ \r\n " + odu-type: + type: "string" + description: "This attribute specifies the type of the ODU termination point." + tapi.odu.OduConnectionEndPointSpec: + type: "object" + properties: + odu-term-and-adapter: + description: "none" + $ref: "#/definitions/tapi.odu.OduTerminationAndClientAdaptationPac" + odu-common: + description: "none" + $ref: "#/definitions/tapi.odu.OduCommonPac" + odu-ctp: + description: "none" + $ref: "#/definitions/tapi.odu.OduCtpPac" + odu-protection: + description: "none" + $ref: "#/definitions/tapi.odu.OduProtectionPac" + tapi.odu.OduConnectivityServiceEndPointSpec: + type: "object" + properties: + accepted-payload-type: + description: "This attribute is applicable when the ODU CTP object instance\ + \ represents a lower order ODU CTP Sink at the client layer of the ODUP/ODU[i]j\ + \ or ODUP/ODUj-21 adaptation function. \r\n This attribute\ + \ is a 2-digit Hex code that indicates the new accepted payload type.\r\n\ + \ Valid values are defined in Table 15-8 of ITU-T Recommendation\ + \ G.709 with one additional value UN_INTERPRETABLE." + $ref: "#/definitions/tapi.odu.OduPayloadType" + opu-tributary-slot-size: + description: "This attribute is applicable for ODU2 and ODU3 CTP only. It\ + \ indicates the slot size of the ODU CTP." + $ref: "#/definitions/tapi.odu.OduSlotSize" + tributary-port-number: + type: "integer" + format: "int32" + description: "This attribute identifies the tributary port number that is\ + \ associated with the ODU CTP.\r\n range of type : The value\ + \ range depends on the size of the Tributary Port Number (TPN) field used\ + \ which depends on th server-layer ODU or OTU.\r\n In case\ + \ of ODUk mapping into OTUk, there is no TPN field, so the tributaryPortNumber\ + \ shall be zero.\r\n In case of LO ODUj mapping over ODU1,\ + \ ODU2 or ODU3, the TPN is encoded in a 6-bit field so the value range is\ + \ 0-63. See clause 14.4.1/G.709-2016.\r\n In case of LO ODUj\ + \ mapping over ODU4, the TPN is encoded in a 7-bit field so the value range\ + \ is 0-127. See clause 14.4.1.4/G.709-2016.\r\n In case of\ + \ ODUk mapping over ODUCn, the TPN is encoded in a 14-bit field so the value\ + \ range is 0-16383. See clause 20.4.1.1/G.709-2016.\r\n " + tributary-slot-list: + type: "array" + description: "This attribute contains a set of distinct (i.e. unique) integers\ + \ (e.g. 2, 3, 5, 9, 15 representing the tributary slots TS2, TS3, TS5, TS9\ + \ and TS15) which represents the resources occupied by the Low Order ODU\ + \ Link Connection (e.g. carrying an ODUflex with a bit rate of 6.25G). \r\ + \n This attribute applies when the LO ODU_ ConnectionTerminationPoint\ + \ connects with an HO ODU_TrailTerminationPoint object. \r\n \ + \ It will not apply if this ODU_ ConnectionTerminationPoint object directly\ + \ connects to an OTU_TrailTerminationPoint object (i.e. OTU has no trib\ + \ slots). \r\n The upper bound of the integer allowed in\ + \ this set is a function of the HO-ODU server layer to which the ODU connection\ + \ has been mapped (adapted). \r\n Thus, for example, M=8/32/80\ + \ for ODU2/ODU3/ODU4 server layers (respectively). Note that the value of\ + \ this attribute can be changed only in the case of ODUflex and has to be\ + \ through specific operations (i.e. not be changing the attribute tributarySlotList\ + \ directly)." + items: + type: "integer" + format: "int32" + configured-mapping-type: + description: "This attributes indicates the configured mapping type." + $ref: "#/definitions/tapi.odu.MappingType" odu-type: type: "string" description: "This attribute specifies the type of the ODU termination point." - tapi.odu.OduConnectionEndPointSpec: - type: "object" - properties: - odu-term-and-adapter: - description: "none" - $ref: "#/definitions/tapi.odu.OduTerminationAndClientAdaptationPac" - odu-common: - description: "none" - $ref: "#/definitions/tapi.odu.OduCommonPac" - odu-ctp: - description: "none" - $ref: "#/definitions/tapi.odu.OduCtpPac" - odu-protection: - description: "none" - $ref: "#/definitions/tapi.odu.OduProtectionPac" tapi.odu.OduCtpPac: type: "object" properties: @@ -17423,35 +15863,34 @@ definitions: type: "integer" format: "int32" description: "This attribute identifies the tributary port number that is\ - \ associated with the ODU CTP.\r\n range of type : The\ - \ value range depends on the size of the Tributary Port Number (TPN) field\ - \ used which depends on th server-layer ODU or OTU.\r\n \ - \ In case of ODUk mapping into OTUk, there is no TPN field, so the tributaryPortNumber\ - \ shall be zero.\r\n In case of LO ODUj mapping over\ - \ ODU1, ODU2 or ODU3, the TPN is encoded in a 6-bit field so the value range\ - \ is 0-63. See clause 14.4.1/G.709-2016.\r\n In case\ - \ of LO ODUj mapping over ODU4, the TPN is encoded in a 7-bit field so the\ - \ value range is 0-127. See clause 14.4.1.4/G.709-2016.\r\n \ - \ In case of ODUk mapping over ODUCn, the TPN is encoded in a 14-bit\ - \ field so the value range is 0-16383. See clause 20.4.1.1/G.709-2016.\r\ - \n " + \ associated with the ODU CTP.\r\n range of type : The value\ + \ range depends on the size of the Tributary Port Number (TPN) field used\ + \ which depends on th server-layer ODU or OTU.\r\n In case\ + \ of ODUk mapping into OTUk, there is no TPN field, so the tributaryPortNumber\ + \ shall be zero.\r\n In case of LO ODUj mapping over ODU1,\ + \ ODU2 or ODU3, the TPN is encoded in a 6-bit field so the value range is\ + \ 0-63. See clause 14.4.1/G.709-2016.\r\n In case of LO ODUj\ + \ mapping over ODU4, the TPN is encoded in a 7-bit field so the value range\ + \ is 0-127. See clause 14.4.1.4/G.709-2016.\r\n In case of\ + \ ODUk mapping over ODUCn, the TPN is encoded in a 14-bit field so the value\ + \ range is 0-16383. See clause 20.4.1.1/G.709-2016.\r\n " tributary-slot-list: type: "array" description: "This attribute contains a set of distinct (i.e. unique) integers\ \ (e.g. 2, 3, 5, 9, 15 representing the tributary slots TS2, TS3, TS5, TS9\ \ and TS15) which represents the resources occupied by the Low Order ODU\ \ Link Connection (e.g. carrying an ODUflex with a bit rate of 6.25G). \r\ - \n This attribute applies when the LO ODU_ ConnectionTerminationPoint\ + \n This attribute applies when the LO ODU_ ConnectionTerminationPoint\ \ connects with an HO ODU_TrailTerminationPoint object. \r\n \ - \ It will not apply if this ODU_ ConnectionTerminationPoint object\ - \ directly connects to an OTU_TrailTerminationPoint object (i.e. OTU has\ - \ no trib slots). \r\n The upper bound of the integer\ - \ allowed in this set is a function of the HO-ODU server layer to which\ - \ the ODU connection has been mapped (adapted). \r\n \ - \ Thus, for example, M=8/32/80 for ODU2/ODU3/ODU4 server layers (respectively).\ - \ Note that the value of this attribute can be changed only in the case\ - \ of ODUflex and has to be through specific operations (i.e. not be changing\ - \ the attribute tributarySlotList directly)." + \ It will not apply if this ODU_ ConnectionTerminationPoint object directly\ + \ connects to an OTU_TrailTerminationPoint object (i.e. OTU has no trib\ + \ slots). \r\n The upper bound of the integer allowed in\ + \ this set is a function of the HO-ODU server layer to which the ODU connection\ + \ has been mapped (adapted). \r\n Thus, for example, M=8/32/80\ + \ for ODU2/ODU3/ODU4 server layers (respectively). Note that the value of\ + \ this attribute can be changed only in the case of ODUflex and has to be\ + \ through specific operations (i.e. not be changing the attribute tributarySlotList\ + \ directly)." items: type: "integer" format: "int32" @@ -17482,6 +15921,57 @@ definitions: type: "boolean" description: "Trail Trace Identifier Mismatch" default: false + tapi.odu.OduMegSpec: + type: "object" + properties: + meg-level: + type: "integer" + format: "int32" + description: "none" + tapi.odu.OduMepPac: + allOf: + - $ref: "#/definitions/tapi.odu.OduMipPac" + - type: "object" + properties: + dm-source: + type: "boolean" + description: "This attribute is for configuring the delay measurement process\ + \ at the trail termination function represented by the subject TTP object\ + \ class. It models the MI_DM_Source MI signal. If MI_DM_Source is false,\ + \ then the value of the DMp bit is determined by the RI_DM. If MI_DM_Source\ + \ is true, then the value of the DMp bit is set to MI_DMValue." + default: false + dm-value: + type: "boolean" + description: "This attribute is for setting the DMp and DMti bits of the\ + \ delay measurement process. The value of 'true' sets the DMp and DMti\ + \ bits to 0 and the value of 'false' to 1." + default: false + txti: + type: "string" + description: "The Trail Trace Identifier (TTI) information, provisioned\ + \ by the managing system at the termination source, to be placed in the\ + \ TTI overhead position of the source of a trail for transmission.\r\n\ + \ " + description: "none" + tapi.odu.OduMepSpec: + type: "object" + properties: + odu-pm: + description: "none" + $ref: "#/definitions/tapi.odu.OduPmPac" + odu-ncm: + description: "none" + $ref: "#/definitions/tapi.odu.OduNcmPac" + odu-mep: + description: "none" + $ref: "#/definitions/tapi.odu.OduMepPac" + odu-tcm: + description: "none" + $ref: "#/definitions/tapi.odu.OduTcmMepPac" + odu-defect: + description: "none" + $ref: "#/definitions/tapi.odu.OduDefectPac" tapi.odu.OduMipPac: type: "object" properties: @@ -17509,7 +15999,7 @@ definitions: description: "The Expected Source Access Point Identifier (ExSAPI), provisioned\ \ by the managing system, to be compared with the TTI accepted at the overhead\ \ position of the sink for the purpose of checking the integrity of connectivity.\r\ - \n " + \n " deg-thr: description: "This attribute indicates the threshold level for declaring a\ \ performance monitoring (PM) Second to be bad. The value of the threshold\ @@ -17636,9 +16126,60 @@ definitions: enum: - "1G25" - "2G5" + tapi.odu.OduTcmMepPac: + type: "object" + properties: + admin-state-sink: + description: "This attribute provides the capability to provision the LOCK\ + \ signal at the sink, which is one of the ODU maintenance signals. When\ + \ a Tandem Connection endpoint is set to admin state locked, it will insert\ + \ the ODU-LCK signal in the downstream direction." + $ref: "#/definitions/tapi.common.AdministrativeState" + codirectional: + type: "boolean" + description: "This attribute specifies the directionality of the ODUT MEP\ + \ with respect to the associated ODU CEP. The value of TRUE means that the\ + \ sink part of the ODUT MEP terminates the same signal direction as the\ + \ sink part of the ODU CEP. The Source part behaves similarly. This attribute\ + \ is meaningful only on objects instantiated under ODU CEP, and at least\ + \ one among ODU CEP and the subordinate object is bidirectional." + default: false + admin-state-source: + description: "This attribute provides the capability to provision the LOCK\ + \ signal at the source, which is one of the ODU maintenance signals. When\ + \ a Tandem Connection endpoint is set to admin state locked, it will insert\ + \ the ODU-LCK signal in the source direction." + $ref: "#/definitions/tapi.common.AdministrativeState" + ac-status-source: + description: "This attribute indicates the status of the accepted TCM. " + $ref: "#/definitions/tapi.odu.TcmStatus" + tcm-extension: + description: "none" + $ref: "#/definitions/tapi.odu.TcmExtension" + ac-status-sink: + description: "This attribute indicates the status of the accepted TCM. " + $ref: "#/definitions/tapi.odu.TcmStatus" + tcm-mode: + description: "This attribute specifies the TCM mode at the entity. Valid values\ + \ are: Operational, Monitor, and Transparent." + $ref: "#/definitions/tapi.odu.TcmMode" + tcm-field: + type: "integer" + format: "int32" + description: "This attribute indicates the tandem connection monitoring field\ + \ of the ODU OH." tapi.odu.OduTcmMipPac: type: "object" properties: + codirectional: + type: "boolean" + description: "This attribute specifies the directionality of the ODU MIP with\ + \ respect to the associated ODU CEP. The value of TRUE means that the (half\ + \ MIP/sink part of the) ODU MIP receives the same signal direction as the\ + \ sink part of the ODU CEP. The Source part behaves similarly. This attribute\ + \ is meaningful only on objects instantiated under ODU CEP, and at least\ + \ one among ODU CEP and the subordinate object is bidirectional." + default: false tcm-field: type: "integer" format: "int32" @@ -17661,9 +16202,9 @@ definitions: accepted-payload-type: description: "This attribute is applicable when the ODU CTP object instance\ \ represents a lower order ODU CTP Sink at the client layer of the ODUP/ODU[i]j\ - \ or ODUP/ODUj-21 adaptation function. \r\n This attribute\ + \ or ODUP/ODUj-21 adaptation function. \r\n This attribute\ \ is a 2-digit Hex code that indicates the new accepted payload type.\r\n\ - \ Valid values are defined in Table 15-8 of ITU-T Recommendation\ + \ Valid values are defined in Table 15-8 of ITU-T Recommendation\ \ G.709 with one additional value UN_INTERPRETABLE." $ref: "#/definitions/tapi.odu.OduPayloadType" opu-tributary-slot-size: @@ -17674,16 +16215,6 @@ definitions: type: "string" description: "This attribute configures the type of the client CTP of the\ \ server ODU TTP." - tapi.odu.OwnedNodeEdgePointAugmentation2: - type: "object" - properties: - odu-node-edge-point-spec: - description: "Augments the base LayerProtocol information in NodeEdgePoint\ - \ with ODU-specific information" - $ref: "#/definitions/tapi.odu.OduNodeEdgePointSpec" - x-augmentation: - prefix: "tapi-odu" - namespace: "urn:onf:otcc:yang:tapi-odu" tapi.odu.PercentageGranularity: type: "string" enum: @@ -17691,6 +16222,29 @@ definitions: - "ONE_TENTHS" - "ONE_HUNDREDTHS" - "ONE_THOUSANDTHS" + tapi.odu.TcmExtension: + type: "string" + enum: + - "NORMAL" + - "PASS-THROUGH" + - "ERASE" + tapi.odu.TcmMode: + type: "string" + enum: + - "OPERATIONAL" + - "TRANSPARENT" + - "MONITOR" + tapi.odu.TcmStatus: + type: "string" + enum: + - "NO_SOURCE_TC" + - "IN_USE_WITHOUT_IAE" + - "IN_USE_WITH_IAE" + - "RESERVED_1" + - "RESERVED_2" + - "LCK" + - "OCI" + - "AIS" tapi.odu.TimDetMo: type: "string" enum: @@ -17722,7 +16276,7 @@ definitions: properties: output: $ref: "#/definitions/tapi.path.computation.computep2ppath.Output" - tapi.path.computation.ContextAugmentation3: + tapi.path.computation.ContextAugmentation2: type: "object" properties: path-computation-context: @@ -17791,8 +16345,10 @@ definitions: - type: "object" properties: topology-constraint: + type: "array" description: "none" - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" path: type: "array" description: "none" @@ -17806,12 +16362,18 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" routing-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.RoutingConstraint" optimization-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" + direction: + description: "none" + $ref: "#/definitions/tapi.common.ForwardingDirection" description: "none" tapi.path.computation.PathObjectiveFunction: allOf: @@ -17876,16 +16438,16 @@ definitions: description: "none" $ref: "#/definitions/tapi.common.Capacity" description: "The association of the FC to LTPs is made via EndPoints.\r\n \ - \ The EndPoint (EP) object class models the access to the FC\ - \ function. \r\n The traffic forwarding between the associated\ - \ EPs of the FC depends upon the type of FC and may be associated with FcSwitch\ - \ object instances. \r\n In cases where there is resilience\ - \ the EndPoint may convey the resilience role of the access to the FC. \r\n\ - \ It can represent a protected (resilient/reliable) point or\ - \ a protecting (unreliable working or protection) point.\r\n \ - \ The EP replaces the Protection Unit of a traditional protection model.\ - \ \r\n The ForwadingConstruct can be considered as a component\ - \ and the EndPoint as a Port on that component" + \ The EndPoint (EP) object class models the access to the FC function.\ + \ \r\n The traffic forwarding between the associated EPs of the\ + \ FC depends upon the type of FC and may be associated with FcSwitch object\ + \ instances. \r\n In cases where there is resilience the EndPoint\ + \ may convey the resilience role of the access to the FC. \r\n \ + \ It can represent a protected (resilient/reliable) point or a protecting\ + \ (unreliable working or protection) point.\r\n The EP replaces\ + \ the Protection Unit of a traditional protection model. \r\n The\ + \ ForwadingConstruct can be considered as a component and the EndPoint as\ + \ a Port on that component" tapi.path.computation.RouteObjectiveFunction: type: "string" enum: @@ -17903,6 +16465,9 @@ definitions: type: "boolean" description: "To distinguish if the resources are to be exclusive to the service" default: true + tolerable-impact: + type: "string" + description: "Grades of maximum tolerable disruption to traffic." diversity-policy: description: "none" $ref: "#/definitions/tapi.path.computation.DiversityPolicy" @@ -17926,78 +16491,100 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.topology.RiskCharacteristic" - route-direction: - description: "none" - $ref: "#/definitions/tapi.common.ForwardingDirection" tapi.path.computation.TopologyConstraint: - type: "object" - properties: - include-node: - type: "array" - description: "This is a loose constraint - that is it is unordered and could\ - \ be a partial list" - items: - $ref: "#/definitions/tapi.topology.NodeRef" - exclude-link: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.LinkRef" - avoid-topology: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.TopologyRef" - exclude-path: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.path.computation.PathRef" - include-link: - type: "array" - description: "This is a loose constraint - that is it is unordered and could\ - \ be a partial list " - items: - $ref: "#/definitions/tapi.topology.LinkRef" - preferred-transport-layer: - type: "array" - description: "soft constraint requested by client to indicate the layer(s)\ - \ of transport connection that it prefers to carry the service. This could\ - \ be same as the service layer or one of the supported server layers" - items: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + include-node: + type: "string" + description: "This is a loose constraint - that is it is unordered and could\ + \ be a partial list" + exclude-link: + type: "string" + description: "none" + avoid-topology: + type: "string" + description: "none" + exclude-path: + type: "string" + description: "none" + include-topology: + type: "string" + description: "none" + include-path: + type: "string" + description: "none" + exclude-node-edge-point: + type: "string" + description: "none" + include-node-edge-point: + type: "string" + description: "none" + include-link: + type: "string" + description: "This is a loose constraint - that is it is unordered and could\ + \ be a partial list " + preferred-transport-layer: + description: "soft constraint requested by client to indicate the layer(s)\ + \ of transport connection that it prefers to carry the service. This could\ + \ be same as the service layer or one of the supported server layers" $ref: "#/definitions/tapi.common.LayerProtocolName" - exclude-node: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.NodeRef" - include-topology: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.TopologyRef" - include-path: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.path.computation.PathRef" + exclude-node: + type: "string" + description: "none" + constraint-weight: + type: "integer" + format: "int32" + description: "Zero and positive values: zero means 'strongly required to\ + \ be included', +1 means 'less strongly required to be included', etc.\r\ + \n For example the work/intended route will be calculated\ + \ considering the topologies which weights are lowest (but not negative).\r\ + \n Negative values: -1 means 'strongly required to be excluded',\ + \ -2 means 'less strongly required to be excluded', etc." + description: "The TopologyConstraint allows to specify topology entities in\ + \ order to impose specific constraints (as denoted by the attribute name)\ + \ on Connectivity/Path.\r\n The topology entities are specified\ + \ by their instance uuid rather than using references/path (to allow for mapping\ + \ to Yang 1.0).\r\n This loose typing and reference necessitates\ + \ that implementations validate not only the presence of the instance, but\ + \ also that it is of the correct type as implied by the attribute name.\r\n\ + \ If this validation fails, then the implementation is expceted\ + \ to return an error.\r\n " tapi.path.computation.computep2ppath.Input: type: "object" properties: topology-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - routing-constraint: + end-point: + type: "array" description: "none" - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + items: + $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" objective-function: description: "none" $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" - sep: + name: type: "array" - description: "none" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." items: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + $ref: "#/definitions/tapi.common.NameAndValue" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.path.computation.computep2ppath.Output: type: "object" properties: @@ -18007,9 +16594,16 @@ definitions: tapi.path.computation.deletep2ppath.Input: type: "object" properties: - path-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.path.computation.deletep2ppath.Output: type: "object" properties: @@ -18019,15 +16613,29 @@ definitions: tapi.path.computation.optimizep2ppath.Input: type: "object" properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" routing-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - path-id-or-name: - type: "string" - description: "none" optimization-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" objective-function: description: "none" $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" @@ -18123,7 +16731,7 @@ definitions: type: "string" description: "High frequency deviation from true periodicity of a signal and\ \ therefore a small high rate of change of transfer latency.\r\n \ - \ Applies to TDM systems (and not packet)." + \ Applies to TDM systems (and not packet)." fixed-latency-characteristic: type: "string" description: "A TopologicalEntity suffers delay caused by the realization\ @@ -18134,7 +16742,7 @@ definitions: type: "string" description: "Low frequency deviation from true periodicity of a signal and\ \ therefore a small low rate of change of transfer latency.\r\n \ - \ Applies to TDM systems (and not packet)." + \ Applies to TDM systems (and not packet)." queing-latency-characteristic: type: "string" description: "The specific queuing latency for the traffic property." @@ -18166,19 +16774,22 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.common.LayerProtocolName" - resilience-type: + restoration-policy: description: "none" - $ref: "#/definitions/tapi.topology.ResilienceType" + $ref: "#/definitions/tapi.topology.RestorationPolicy" node-edge-point: type: "array" description: "none" items: $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + protection-type: + description: "none" + $ref: "#/definitions/tapi.topology.ProtectionType" direction: - description: "The directionality of the Link. \r\n Is\ - \ applicable to simple Links where all LinkEnds are BIDIRECTIONAL (the\ - \ Link will be BIDIRECTIONAL) or UNIDIRECTIONAL (the Link will be UNIDIRECTIONAL).\ - \ \r\n Is not present in more complex cases." + description: "The directionality of the Link. \r\n Is applicable\ + \ to simple Links where all LinkEnds are BIDIRECTIONAL (the Link will\ + \ be BIDIRECTIONAL) or UNIDIRECTIONAL (the Link will be UNIDIRECTIONAL).\ + \ \r\n Is not present in more complex cases." $ref: "#/definitions/tapi.common.ForwardingDirection" description: "The Link object class models effective adjacency between two or\ \ more ForwardingDomains (FD). " @@ -18192,6 +16803,16 @@ definitions: description: "none" x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:link/tapi-topology:uuid" description: "none" + tapi.topology.NepLayerProtocolCapability: + type: "object" + properties: + layer-protocol-qualifier: + type: "string" + description: "none" + number-of-cep-instances: + type: "integer" + format: "int32" + description: "none" tapi.topology.NetworkTopologyService: allOf: - $ref: "#/definitions/tapi.common.GlobalClass" @@ -18221,16 +16842,16 @@ definitions: encap-topology: description: "none" $ref: "#/definitions/tapi.topology.TopologyRef" - owned-node-edge-point: + node-rule-group: type: "array" description: "none" items: - $ref: "#/definitions/tapi.topology.NodeEdgePoint" - node-rule-group: + $ref: "#/definitions/tapi.topology.NodeRuleGroup" + node-edge-point: type: "array" description: "none" items: - $ref: "#/definitions/tapi.topology.NodeRuleGroup" + $ref: "#/definitions/tapi.topology.NodeEdgePoint" aggregated-node-edge-point: type: "array" description: "none" @@ -18239,8 +16860,8 @@ definitions: description: "The ForwardingDomain (FD) object class models the ForwardingDomain\ \ topological component which is used to effect forwarding of transport characteristic\ \ information and offers the potential to enable forwarding. \r\n \ - \ At the lowest level of recursion, an FD (within a network element\ - \ (NE)) represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ + \ At the lowest level of recursion, an FD (within a network element (NE))\ + \ represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ \ multiple switch matrices (FDs). " tapi.topology.NodeEdgePoint: allOf: @@ -18262,6 +16883,11 @@ definitions: \ balancing/Resilience) should be considered experimental" items: $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + available-cep-layer-protocol: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NepLayerProtocolCapability" aggregated-node-edge-point: type: "array" description: "none" @@ -18273,14 +16899,9 @@ definitions: link-port-direction: description: "The orientation of defined flow at the LinkEnd." $ref: "#/definitions/tapi.common.PortDirection" - supported-cep-layer-protocol-qualifier: - type: "array" - description: "none" - items: - type: "string" description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ \ termination and adaptation functions of one or more transport layers. \r\ - \n The structure of LTP supports all transport protocols including\ + \n The structure of LTP supports all transport protocols including\ \ circuit and packet forms." tapi.topology.NodeEdgePointRef: allOf: @@ -18290,7 +16911,7 @@ definitions: node-edge-point-uuid: type: "string" description: "none" - x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:owned-node-edge-point/tapi-topology:uuid" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:node-edge-point/tapi-topology:uuid" description: "none" tapi.topology.NodeRef: allOf: @@ -18345,41 +16966,32 @@ definitions: tapi.topology.ProtectionType: type: "string" enum: - - "NO_PROTECTON" + - "NO_PROTECTION" - "ONE_PLUS_ONE_PROTECTION" - - "ONE_PLUS_ONE_PROTECTION_WITH_DYNAMIC_RESTORATION" - - "PERMANENT_ONE_PLUS_ONE_PROTECTION" - "ONE_FOR_ONE_PROTECTION" - - "DYNAMIC_RESTORATION" - - "PRE_COMPUTED_RESTORATION" - tapi.topology.ResilienceType: - type: "object" - properties: - restoration-policy: - description: "none" - $ref: "#/definitions/tapi.topology.RestorationPolicy" - protection-type: - description: "none" - $ref: "#/definitions/tapi.topology.ProtectionType" + - "ONE_FOR_N_PROTECTION" + - "M_FOR_N_PROTECTION" + - "ONE_FOR_ONE_BY_N" tapi.topology.RestorationPolicy: type: "string" enum: - "PER_DOMAIN_RESTORATION" - "END_TO_END_RESTORATION" - "NA" + - "DYNAMIC_RESTORATION" + - "PRE_COMPUTED_RESTORATION" tapi.topology.RiskCharacteristic: type: "object" properties: risk-characteristic-name: type: "string" description: "The name of the risk characteristic. The characteristic may\ - \ be related to a specific degree of closeness. \r\n \ - \ For example a particular characteristic may apply to failures that are\ - \ localized (e.g. to one side of a road) where as another characteristic\ - \ may relate to failures that have a broader impact (e.g. both sides of\ - \ a road that crosses a bridge).\r\n Depending upon the\ - \ importance of the traffic being routed different risk characteristics\ - \ will be evaluated." + \ be related to a specific degree of closeness. \r\n For\ + \ example a particular characteristic may apply to failures that are localized\ + \ (e.g. to one side of a road) where as another characteristic may relate\ + \ to failures that have a broader impact (e.g. both sides of a road that\ + \ crosses a bridge).\r\n Depending upon the importance of\ + \ the traffic being routed different risk characteristics will be evaluated." risk-identifier-list: type: "array" description: "A list of the identifiers of each physical/geographic unit (with\ @@ -18441,11 +17053,16 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.topology.Node" + boundary-node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" description: "The ForwardingDomain (FD) object class models the ForwardingDomain\ \ topological component which is used to effect forwarding of transport characteristic\ \ information and offers the potential to enable forwarding. \r\n \ - \ At the lowest level of recursion, an FD (within a network element\ - \ (NE)) represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ + \ At the lowest level of recursion, an FD (within a network element (NE))\ + \ represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ \ multiple switch matrices (FDs). " tapi.topology.TopologyContext: type: "object" @@ -18480,7 +17097,7 @@ definitions: error-characteristic: type: "string" description: "Describes the degree to which the signal propagated can be errored.\ - \ \r\n Applies to TDM systems as the errored signal will\ + \ \r\n Applies to TDM systems as the errored signal will\ \ be propagated and not packet as errored packets will be discarded." unavailable-time-characteristic: type: "string" @@ -18493,19 +17110,19 @@ definitions: delivery-order-characteristic: type: "string" description: "Describes the degree to which packets will be delivered out\ - \ of sequence.\r\n Does not apply to TDM as the TDM protocols\ + \ of sequence.\r\n Does not apply to TDM as the TDM protocols\ \ maintain strict order." repeat-delivery-characteristic: type: "string" description: "Primarily applies to packet systems where a packet may be delivered\ - \ more than once (in fault recovery for example). \r\n \ - \ It can also apply to TDM where several frames may be received twice\ - \ due to switching in a system with a large differential propagation delay." + \ more than once (in fault recovery for example). \r\n It\ + \ can also apply to TDM where several frames may be received twice due to\ + \ switching in a system with a large differential propagation delay." loss-characteristic: type: "string" description: "Describes the acceptable characteristic of lost packets where\ \ loss may result from discard due to errors or overflow.\r\n \ - \ Applies to packet systems and not TDM (as for TDM errored signals\ + \ Applies to packet systems and not TDM (as for TDM errored signals\ \ are propagated unless grossly errored and overflow/underflow turns into\ \ timing slips)." tapi.topology.TransferTimingPac: @@ -18542,12 +17159,27 @@ definitions: tapi.topology.getlinkdetails.Input: type: "object" properties: - link-id-or-name: + link-id: type: "string" - description: "none" - topology-id-or-name: - type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.topology.getlinkdetails.Output: type: "object" properties: @@ -18557,12 +17189,27 @@ definitions: tapi.topology.getnodedetails.Input: type: "object" properties: - node-id-or-name: - type: "string" - description: "none" - topology-id-or-name: - type: "string" - description: "none" + node-id: + type: "string" + description: "UUID of the Node: An identifier that is universally unique within\ + \ an identifier space, where the identifier space is itself globally unique,\ + \ and immutable.\r\n An UUID carries no semantics with\ + \ respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC 4122. The canonical\ + \ representation uses lowercase characters.\r\n Pattern:\ + \ [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\ + \ \r\n Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.topology.getnodedetails.Output: type: "object" properties: @@ -18572,15 +17219,37 @@ definitions: tapi.topology.getnodeedgepointdetails.Input: type: "object" properties: - ep-id-or-name: - type: "string" - description: "none" - node-id-or-name: - type: "string" - description: "none" - topology-id-or-name: + node-id: + type: "string" + description: "UUID of the parent Node: An identifier that is universally unique\ + \ within an identifier space, where the identifier space is itself globally\ + \ unique, and immutable.\r\n An UUID carries no semantics\ + \ with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC 4122. The\ + \ canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\ + \ \r\n Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Node's Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + node-edge-point-id: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.topology.getnodeedgepointdetails.Output: type: "object" properties: @@ -18590,9 +17259,16 @@ definitions: tapi.topology.gettopologydetails.Input: type: "object" properties: - topology-id-or-name: + topology-id: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.topology.gettopologydetails.Output: type: "object" properties: @@ -18607,10 +17283,10 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.topology.Topology" - tapi.topology.node.OwnedNodeEdgePoint: + tapi.topology.node.NodeEdgePoint: allOf: - - $ref: "#/definitions/tapi.connectivity.OwnedNodeEdgePointAugmentation1" - - $ref: "#/definitions/tapi.odu.OwnedNodeEdgePointAugmentation2" + - $ref: "#/definitions/tapi.connectivity.NodeEdgePointAugmentation2" + - $ref: "#/definitions/tapi.odu.NodeEdgePointAugmentation1" - $ref: "#/definitions/tapi.topology.NodeEdgePoint" tapi.topology.topology.Node: allOf: @@ -18630,16 +17306,16 @@ definitions: encap-topology: description: "none" $ref: "#/definitions/tapi.topology.TopologyRef" - owned-node-edge-point: + node-rule-group: type: "array" description: "none" items: - $ref: "#/definitions/tapi.topology.node.OwnedNodeEdgePoint" - node-rule-group: + $ref: "#/definitions/tapi.topology.NodeRuleGroup" + node-edge-point: type: "array" description: "none" items: - $ref: "#/definitions/tapi.topology.NodeRuleGroup" + $ref: "#/definitions/tapi.topology.node.NodeEdgePoint" aggregated-node-edge-point: type: "array" description: "none" diff --git a/OAS/tapi-path-computation@2018-12-10.yaml b/OAS/tapi-path-computation@2019-03-31.yaml similarity index 63% rename from OAS/tapi-path-computation@2018-12-10.yaml rename to OAS/tapi-path-computation@2019-03-31.yaml index 975aa5e7..cd1e4758 100644 --- a/OAS/tapi-path-computation@2018-12-10.yaml +++ b/OAS/tapi-path-computation@2019-03-31.yaml @@ -1,10 +1,73 @@ --- swagger: "2.0" info: - description: "tapi-path-computation,tapi-notification,tapi-topology,tapi-common\ - \ API generated from yang definitions" - version: "1.0" - title: "tapi-path-computation,tapi-notification,tapi-topology,tapi-common API" + description: "\r\n This module contains TAPI Notification Model definitions.\r\ + \n Source: TapiNotification.uml\r\n Copyright (c) 2018 Open Networking\ + \ Foundation (ONF). All rights reserved.\r\n License: This module is distributed\ + \ under the Apache License 2.0\r\n - The TAPI YANG models included in this\ + \ TAPI release are a *normative* part of the TAPI SDK.\r\n - The YANG specifications\ + \ have been generated from the corresponding UML model using the [ONF EAGLE UML2YANG\ + \ mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Topology\ + \ Model definitions.\r\n Source: TapiTopology.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Common Model\ + \ definitions.\r\n Source: TapiCommon.uml\r\n Copyright (c) 2018\ + \ Open Networking Foundation (ONF). All rights reserved.\r\n License: This\ + \ module is distributed under the Apache License 2.0\r\n - The TAPI YANG\ + \ models included in this TAPI release are a *normative* part of the TAPI SDK.\r\ + \n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Path Computation\ + \ Model definitions.\r\n Source: TapiPathComputation.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases." + version: "2.2.0" + title: "tapi-notification,tapi-topology,tapi-common,tapi-path-computation API" host: "localhost:1234" consumes: - "application/yang-data+json" @@ -15,7 +78,8 @@ paths: get: tags: - "tapi-common" - description: "returns tapi.common.Context" + summary: "returns tapi.common.Context" + description: "none" parameters: [] responses: 200: @@ -27,7 +91,8 @@ paths: post: tags: - "tapi-common" - description: "creates tapi.common.Context" + summary: "creates tapi.common.Context" + description: "none" parameters: - in: "body" name: "tapi.common.Context.body-param" @@ -45,7 +110,8 @@ paths: put: tags: - "tapi-common" - description: "creates or updates tapi.common.Context" + summary: "creates or updates tapi.common.Context" + description: "none" parameters: - in: "body" name: "tapi.common.Context.body-param" @@ -63,7 +129,8 @@ paths: delete: tags: - "tapi-common" - description: "removes tapi.common.Context" + summary: "removes tapi.common.Context" + description: "none" parameters: [] responses: 400: @@ -74,7 +141,10 @@ paths: post: tags: - "tapi-common" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - in: "body" name: "tapi.common.NameAndValue.body-param" @@ -93,7 +163,10 @@ paths: get: tags: - "tapi-common" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "value-name" in: "path" @@ -107,33 +180,13 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-common" - description: "creates or updates tapi.common.NameAndValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "value-name" in: "path" @@ -156,7 +209,10 @@ paths: delete: tags: - "tapi-common" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "value-name" in: "path" @@ -172,7 +228,8 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.notification.NotificationContext" + summary: "returns tapi.notification.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" parameters: [] responses: 200: @@ -184,7 +241,8 @@ paths: post: tags: - "tapi-notification" - description: "creates tapi.notification.NotificationContext" + summary: "creates tapi.notification.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" parameters: - in: "body" name: "tapi.notification.NotificationContext.body-param" @@ -202,7 +260,8 @@ paths: put: tags: - "tapi-notification" - description: "creates or updates tapi.notification.NotificationContext" + summary: "creates or updates tapi.notification.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" parameters: - in: "body" name: "tapi.notification.NotificationContext.body-param" @@ -220,7 +279,8 @@ paths: delete: tags: - "tapi-notification" - description: "removes tapi.notification.NotificationContext" + summary: "removes tapi.notification.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" parameters: [] responses: 400: @@ -231,7 +291,8 @@ paths: post: tags: - "tapi-notification" - description: "creates tapi.notification.NotificationSubscriptionService" + summary: "creates tapi.notification.NotificationSubscriptionService" + description: "none" parameters: - in: "body" name: "tapi.notification.NotificationSubscriptionService.body-param" @@ -251,7 +312,8 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.notification.NotificationSubscriptionService" + summary: "returns tapi.notification.NotificationSubscriptionService" + description: "none" parameters: - name: "uuid" in: "path" @@ -265,34 +327,11 @@ paths: $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" 400: description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationSubscriptionService" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationSubscriptionService.body-param" - description: "tapi.notification.NotificationSubscriptionService to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-notification" - description: "creates or updates tapi.notification.NotificationSubscriptionService" + summary: "creates or updates tapi.notification.NotificationSubscriptionService" + description: "none" parameters: - name: "uuid" in: "path" @@ -316,7 +355,8 @@ paths: delete: tags: - "tapi-notification" - description: "removes tapi.notification.NotificationSubscriptionService" + summary: "removes tapi.notification.NotificationSubscriptionService" + description: "none" parameters: - name: "uuid" in: "path" @@ -332,7 +372,10 @@ paths: post: tags: - "tapi-notification" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -356,7 +399,10 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -375,38 +421,13 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -434,7 +455,10 @@ paths: delete: tags: - "tapi-notification" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -455,7 +479,8 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.notification.NotificationChannel" + summary: "returns tapi.notification.NotificationChannel" + description: "none" parameters: - name: "uuid" in: "path" @@ -469,96 +494,14 @@ paths: $ref: "#/definitions/tapi.notification.NotificationChannel" 400: description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationChannel.body-param" - description: "tapi.notification.NotificationChannel to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationChannel.body-param" - description: "tapi.notification.NotificationChannel to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/notification-channel/name/: - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" /data/context/notification-context/notif-subscription={uuid}/notification-channel/name={value-name}/: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -577,87 +520,12 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/: get: tags: - "tapi-notification" - description: "returns tapi.notification.Notification" + summary: "returns tapi.notification.Notification" + description: "none" parameters: - name: "uuid" in: "path" @@ -680,7 +548,8 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -704,34 +573,12 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/alarm-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.AlarmInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.AlarmInfo" - schema: - $ref: "#/definitions/tapi.notification.AlarmInfo" - 400: - description: "Internal error" /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/changed-attributes={value-name}/: get: tags: - "tapi-notification" - description: "returns tapi.notification.NameAndValueChange" + summary: "returns tapi.notification.NameAndValueChange" + description: "none" parameters: - name: "uuid" in: "path" @@ -759,7 +606,10 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -787,7 +637,8 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -811,34 +662,12 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/tca-info/: + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/: get: tags: - "tapi-notification" - description: "returns tapi.notification.TcaInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.TcaInfo" - schema: - $ref: "#/definitions/tapi.notification.TcaInfo" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/subscription-filter/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.SubscriptionFilter" + summary: "returns tapi.notification.SubscriptionFilter" + description: "none" parameters: - name: "uuid" in: "path" @@ -855,7 +684,8 @@ paths: post: tags: - "tapi-notification" - description: "creates tapi.notification.SubscriptionFilter" + summary: "creates tapi.notification.SubscriptionFilter" + description: "none" parameters: - name: "uuid" in: "path" @@ -878,7 +708,8 @@ paths: put: tags: - "tapi-notification" - description: "creates or updates tapi.notification.SubscriptionFilter" + summary: "creates or updates tapi.notification.SubscriptionFilter" + description: "none" parameters: - name: "uuid" in: "path" @@ -901,7 +732,8 @@ paths: delete: tags: - "tapi-notification" - description: "removes tapi.notification.SubscriptionFilter" + summary: "removes tapi.notification.SubscriptionFilter" + description: "none" parameters: - name: "uuid" in: "path" @@ -917,7 +749,10 @@ paths: post: tags: - "tapi-notification" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -941,7 +776,10 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -960,38 +798,13 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -1019,7 +832,10 @@ paths: delete: tags: - "tapi-notification" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -1040,7 +856,8 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.notification.Notification" + summary: "returns tapi.notification.Notification" + description: "none" parameters: - name: "uuid" in: "path" @@ -1058,7 +875,8 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -1077,29 +895,12 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/notification-context/notification={uuid}/alarm-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.AlarmInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.AlarmInfo" - schema: - $ref: "#/definitions/tapi.notification.AlarmInfo" - 400: - description: "Internal error" /data/context/notification-context/notification={uuid}/changed-attributes={value-name}/: get: tags: - "tapi-notification" - description: "returns tapi.notification.NameAndValueChange" + summary: "returns tapi.notification.NameAndValueChange" + description: "none" parameters: - name: "uuid" in: "path" @@ -1122,7 +923,10 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -1145,7 +949,8 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -1164,29 +969,12 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/notification-context/notification={uuid}/tca-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.TcaInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.TcaInfo" - schema: - $ref: "#/definitions/tapi.notification.TcaInfo" - 400: - description: "Internal error" /data/context/path-computation-context/: get: tags: - "tapi-path-computation" - description: "returns tapi.path.computation.PathComputationContext" + summary: "returns tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" parameters: [] responses: 200: @@ -1198,7 +986,8 @@ paths: post: tags: - "tapi-path-computation" - description: "creates tapi.path.computation.PathComputationContext" + summary: "creates tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" parameters: - in: "body" name: "tapi.path.computation.PathComputationContext.body-param" @@ -1217,7 +1006,8 @@ paths: put: tags: - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathComputationContext" + summary: "creates or updates tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" parameters: - in: "body" name: "tapi.path.computation.PathComputationContext.body-param" @@ -1236,7 +1026,8 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.path.computation.PathComputationContext" + summary: "removes tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" parameters: [] responses: 400: @@ -1247,7 +1038,8 @@ paths: post: tags: - "tapi-path-computation" - description: "creates tapi.path.computation.PathComputationService" + summary: "creates tapi.path.computation.PathComputationService" + description: "none" parameters: - in: "body" name: "tapi.path.computation.PathComputationService.body-param" @@ -1267,7 +1059,8 @@ paths: get: tags: - "tapi-path-computation" - description: "returns tapi.path.computation.PathComputationService" + summary: "returns tapi.path.computation.PathComputationService" + description: "none" parameters: - name: "uuid" in: "path" @@ -1281,34 +1074,11 @@ paths: $ref: "#/definitions/tapi.path.computation.PathComputationService" 400: description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathComputationService" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathComputationService.body-param" - description: "tapi.path.computation.PathComputationService to be added to\ - \ list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathComputationService" + summary: "creates or updates tapi.path.computation.PathComputationService" + description: "none" parameters: - name: "uuid" in: "path" @@ -1332,7 +1102,8 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.path.computation.PathComputationService" + summary: "removes tapi.path.computation.PathComputationService" + description: "none" parameters: - name: "uuid" in: "path" @@ -1348,7 +1119,8 @@ paths: post: tags: - "tapi-path-computation" - description: "creates tapi.path.computation.PathServiceEndPoint" + summary: "creates tapi.path.computation.PathServiceEndPoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -1372,7 +1144,8 @@ paths: get: tags: - "tapi-path-computation" - description: "returns tapi.path.computation.PathServiceEndPoint" + summary: "returns tapi.path.computation.PathServiceEndPoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -1391,38 +1164,11 @@ paths: $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" 400: description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathServiceEndPoint.body-param" - description: "tapi.path.computation.PathServiceEndPoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathServiceEndPoint" + summary: "creates or updates tapi.path.computation.PathServiceEndPoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -1450,7 +1196,8 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.path.computation.PathServiceEndPoint" + summary: "removes tapi.path.computation.PathServiceEndPoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -1471,7 +1218,8 @@ paths: get: tags: - "tapi-path-computation" - description: "returns tapi.common.Capacity" + summary: "returns tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" @@ -1493,7 +1241,8 @@ paths: post: tags: - "tapi-path-computation" - description: "creates tapi.common.Capacity" + summary: "creates tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" @@ -1521,7 +1270,8 @@ paths: put: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.Capacity" + summary: "creates or updates tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" @@ -1549,7 +1299,8 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.common.Capacity" + summary: "removes tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" @@ -1566,11 +1317,13 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/: + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/total-size/: get: tags: - "tapi-path-computation" - description: "returns tapi.common.BandwidthProfile" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -1584,15 +1337,17 @@ paths: type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" post: tags: - "tapi-path-computation" - description: "creates tapi.common.BandwidthProfile" + summary: "creates tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -1605,11 +1360,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.BandwidthProfile.body-param" - description: "tapi.common.BandwidthProfile to be added to list" + name: "tapi.common.CapacityValue.body-param" + description: "tapi.common.CapacityValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.common.CapacityValue" responses: 201: description: "Object created" @@ -1620,7 +1375,9 @@ paths: put: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.BandwidthProfile" + summary: "creates or updates tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -1633,11 +1390,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.BandwidthProfile.body-param" - description: "tapi.common.BandwidthProfile to be added or updated" + name: "tapi.common.CapacityValue.body-param" + description: "tapi.common.CapacityValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.common.CapacityValue" responses: 201: description: "Object created" @@ -1648,7 +1405,9 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.common.BandwidthProfile" + summary: "removes tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -1665,11 +1424,14 @@ paths: description: "Internal error" 204: description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-burst-size/ - : get: + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/name/: + post: tags: - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -1681,17 +1443,27 @@ paths: description: "Id of end-point" required: true type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/name={value-name}/: + get: tags: - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -1703,23 +1475,25 @@ paths: description: "Id of end-point" required: true type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" responses: - 201: - description: "Object created" + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -1731,12 +1505,17 @@ paths: description: "Id of end-point" required: true type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -1747,7 +1526,10 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -1759,16 +1541,22 @@ paths: description: "Id of end-point" required: true type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-information-rate/ - : get: + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/service-interface-point/: + get: tags: - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1782,15 +1570,16 @@ paths: type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.ServiceInterfacePointRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" 400: description: "Internal error" post: tags: - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" + summary: "creates tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1803,11 +1592,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.common.ServiceInterfacePointRef.body-param" + description: "tapi.common.ServiceInterfacePointRef to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" responses: 201: description: "Object created" @@ -1818,7 +1607,8 @@ paths: put: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1831,11 +1621,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.common.ServiceInterfacePointRef.body-param" + description: "tapi.common.ServiceInterfacePointRef to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" responses: 201: description: "Object created" @@ -1846,7 +1636,8 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1863,78 +1654,83 @@ paths: description: "Internal error" 204: description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-burst-size/ - : get: + /data/context/path-computation-context/path-comp-service={uuid}/name/: + post: tags: - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/name={value-name}/: + get: tags: - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of end-point" + description: "Id of name" required: true type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of end-point" + description: "Id of name" required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -1945,16 +1741,19 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of end-point" + description: "Id of name" required: true type: "string" responses: @@ -1962,50 +1761,42 @@ paths: description: "Internal error" 204: description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-information-rate/ - : get: + /data/context/path-computation-context/path-comp-service={uuid}/objective-function/: + get: tags: - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.path.computation.PathObjectiveFunction" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.path.computation.PathObjectiveFunction" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" 400: description: "Internal error" post: tags: - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" + summary: "creates tapi.path.computation.PathObjectiveFunction" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.path.computation.PathObjectiveFunction.body-param" + description: "tapi.path.computation.PathObjectiveFunction to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" responses: 201: description: "Object created" @@ -2016,24 +1807,20 @@ paths: put: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.path.computation.PathObjectiveFunction" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.path.computation.PathObjectiveFunction.body-param" + description: "tapi.path.computation.PathObjectiveFunction to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" responses: 201: description: "Object created" @@ -2044,95 +1831,96 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.path.computation.PathObjectiveFunction" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/total-size/: - get: + /data/context/path-computation-context/path-comp-service={uuid}/objective-function/name/: + post: tags: - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/objective-function/name={value-name}/: + get: tags: - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of end-point" + description: "Id of name" required: true type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of end-point" + description: "Id of name" required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -2143,16 +1931,19 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of end-point" + description: "Id of name" required: true type: "string" responses: @@ -2160,89 +1951,43 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/name/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/name={value-name}/: + /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/: get: tags: - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.path.computation.PathOptimizationConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.path.computation.PathOptimizationConstraint" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" 400: description: "Internal error" post: tags: - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.path.computation.PathOptimizationConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.path.computation.PathOptimizationConstraint.body-param" + description: "tapi.path.computation.PathOptimizationConstraint to be added\ + \ to list" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" responses: 201: description: "Object created" @@ -2253,29 +1998,21 @@ paths: put: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" + summary: "creates or updates tapi.path.computation.PathOptimizationConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" + name: "tapi.path.computation.PathOptimizationConstraint.body-param" + description: "tapi.path.computation.PathOptimizationConstraint to be added\ + \ or updated" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" responses: 201: description: "Object created" @@ -2286,56 +2023,27 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.path.computation.PathOptimizationConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/service-interface-point/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.ServiceInterfacePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.ServiceInterfacePointRef" - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/name/: + /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name/: post: tags: - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -2355,11 +2063,14 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/name={value-name}/: + /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name={value-name}/: get: tags: - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -2378,10 +2089,13 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: + put: tags: - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -2395,7 +2109,7 @@ paths: type: "string" - in: "body" name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: $ref: "#/definitions/tapi.common.NameAndValue" @@ -2404,12 +2118,15 @@ paths: description: "Object created" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + 204: + description: "Object modified" + delete: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -2421,44 +2138,41 @@ paths: description: "Id of name" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" responses: - 201: - description: "Object created" 400: description: "Internal error" 204: - description: "Object modified" - delete: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/path={path-uuid}/: + get: tags: - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" + summary: "returns tapi.path.computation.PathRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "value-name" + - name: "path-uuid" in: "path" - description: "Id of name" + description: "Id of path" required: true type: "string" responses: + 200: + description: "tapi.path.computation.PathRef" + schema: + $ref: "#/definitions/tapi.path.computation.PathRef" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/objective-function/: + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/: get: tags: - "tapi-path-computation" - description: "returns tapi.path.computation.PathObjectiveFunction" + summary: "returns tapi.path.computation.RoutingConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -2467,15 +2181,16 @@ paths: type: "string" responses: 200: - description: "tapi.path.computation.PathObjectiveFunction" + description: "tapi.path.computation.RoutingConstraint" schema: - $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" 400: description: "Internal error" post: tags: - "tapi-path-computation" - description: "creates tapi.path.computation.PathObjectiveFunction" + summary: "creates tapi.path.computation.RoutingConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -2483,11 +2198,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.path.computation.PathObjectiveFunction.body-param" - description: "tapi.path.computation.PathObjectiveFunction to be added to list" + name: "tapi.path.computation.RoutingConstraint.body-param" + description: "tapi.path.computation.RoutingConstraint to be added to list" required: false schema: - $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" responses: 201: description: "Object created" @@ -2498,7 +2213,8 @@ paths: put: tags: - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathObjectiveFunction" + summary: "creates or updates tapi.path.computation.RoutingConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -2506,11 +2222,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.path.computation.PathObjectiveFunction.body-param" - description: "tapi.path.computation.PathObjectiveFunction to be added or updated" + name: "tapi.path.computation.RoutingConstraint.body-param" + description: "tapi.path.computation.RoutingConstraint to be added or updated" required: false schema: - $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" responses: 201: description: "Object created" @@ -2521,7 +2237,8 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.path.computation.PathObjectiveFunction" + summary: "removes tapi.path.computation.RoutingConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -2533,11 +2250,13 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/objective-function/name/: + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic/: post: tags: - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" @@ -2545,11 +2264,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.topology.CostCharacteristic.body-param" + description: "tapi.topology.CostCharacteristic to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.topology.CostCharacteristic" responses: 201: description: "Object created" @@ -2557,78 +2276,54 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/objective-function/name={value-name}/: + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic={cost-name}/: get: tags: - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "value-name" + - name: "cost-name" in: "path" - description: "Id of name" + description: "Id of cost-characteristic" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.topology.CostCharacteristic" schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" + $ref: "#/definitions/tapi.topology.CostCharacteristic" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" + summary: "creates or updates tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "value-name" + - name: "cost-name" in: "path" - description: "Id of name" + description: "Id of cost-characteristic" required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" + name: "tapi.topology.CostCharacteristic.body-param" + description: "tapi.topology.CostCharacteristic to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.topology.CostCharacteristic" responses: 201: description: "Object created" @@ -2639,16 +2334,18 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "value-name" + - name: "cost-name" in: "path" - description: "Id of name" + description: "Id of cost-characteristic" required: true type: "string" responses: @@ -2656,65 +2353,80 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/: - get: + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/latency-characteristic/: + post: tags: - "tapi-path-computation" - description: "returns tapi.path.computation.PathOptimizationConstraint" + summary: "creates tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" + - in: "body" + name: "tapi.topology.LatencyCharacteristic.body-param" + description: "tapi.topology.LatencyCharacteristic to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" responses: - 200: - description: "tapi.path.computation.PathOptimizationConstraint" - schema: - $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + ? /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/ + : get: tags: - "tapi-path-computation" - description: "creates tapi.path.computation.PathOptimizationConstraint" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - in: "body" - name: "tapi.path.computation.PathOptimizationConstraint.body-param" - description: "tapi.path.computation.PathOptimizationConstraint to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" responses: - 201: - description: "Object created" + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathOptimizationConstraint" + summary: "creates or updates tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" - in: "body" - name: "tapi.path.computation.PathOptimizationConstraint.body-param" - description: "tapi.path.computation.PathOptimizationConstraint to be added\ - \ or updated" + name: "tapi.topology.LatencyCharacteristic.body-param" + description: "tapi.topology.LatencyCharacteristic to be added or updated" required: false schema: - $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" responses: 201: description: "Object created" @@ -2725,23 +2437,31 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.path.computation.PathOptimizationConstraint" + summary: "removes tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name/: + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/risk-diversity-characteristic/: post: tags: - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" @@ -2749,11 +2469,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.topology.RiskCharacteristic.body-param" + description: "tapi.topology.RiskCharacteristic to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.topology.RiskCharacteristic" responses: 201: description: "Object created" @@ -2761,185 +2481,151 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name={value-name}/: - get: + ? /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/ + : get: tags: - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "value-name" + - name: "risk-characteristic-name" in: "path" - description: "Id of name" + description: "Id of risk-diversity-characteristic" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.topology.RiskCharacteristic" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.topology.RiskCharacteristic" 400: description: "Internal error" - post: + put: tags: - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" + summary: "creates or updates tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "value-name" + - name: "risk-characteristic-name" in: "path" - description: "Id of name" + description: "Id of risk-diversity-characteristic" required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.topology.RiskCharacteristic.body-param" + description: "tapi.topology.RiskCharacteristic to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.topology.RiskCharacteristic" responses: 201: description: "Object created" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + 204: + description: "Object modified" + delete: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" + summary: "removes tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "value-name" + - name: "risk-characteristic-name" in: "path" - description: "Id of name" + description: "Id of risk-diversity-characteristic" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" responses: - 201: - description: "Object created" 400: description: "Internal error" 204: - description: "Object modified" - delete: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/: + post: tags: - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" + summary: "creates tapi.path.computation.TopologyConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" + - in: "body" + name: "tapi.path.computation.TopologyConstraint.body-param" + description: "tapi.path.computation.TopologyConstraint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" responses: + 201: + description: "Object created" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/path={path-uuid}/: + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint={local-id}/: get: tags: - "tapi-path-computation" - description: "returns tapi.path.computation.PathRef" + summary: "returns tapi.path.computation.TopologyConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "path-uuid" + - name: "local-id" in: "path" - description: "Id of path" + description: "Id of topology-constraint" required: true type: "string" responses: 200: - description: "tapi.path.computation.PathRef" + description: "tapi.path.computation.TopologyConstraint" schema: - $ref: "#/definitions/tapi.path.computation.PathRef" + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" 400: description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/: - get: + put: tags: - "tapi-path-computation" - description: "returns tapi.path.computation.RoutingConstraint" + summary: "creates or updates tapi.path.computation.TopologyConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - responses: - 200: - description: "tapi.path.computation.RoutingConstraint" - schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.RoutingConstraint.body-param" - description: "tapi.path.computation.RoutingConstraint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" + - name: "local-id" in: "path" - description: "Id of path-comp-service" + description: "Id of topology-constraint" required: true type: "string" - in: "body" - name: "tapi.path.computation.RoutingConstraint.body-param" - description: "tapi.path.computation.RoutingConstraint to be added or updated" + name: "tapi.path.computation.TopologyConstraint.body-param" + description: "tapi.path.computation.TopologyConstraint to be added or updated" required: false schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" responses: 201: description: "Object created" @@ -2950,35 +2636,49 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.path.computation.RoutingConstraint" + summary: "removes tapi.path.computation.TopologyConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic/: + /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint={local-id}/name/: post: tags: - "tapi-path-computation" - description: "creates tapi.topology.CostCharacteristic" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -2986,78 +2686,66 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic={cost-name}/: + /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint={local-id}/name={value-name}/: get: tags: - "tapi-path-computation" - description: "returns tapi.topology.CostCharacteristic" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "cost-name" + - name: "local-id" in: "path" - description: "Id of cost-characteristic" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.topology.CostCharacteristic" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: + put: tags: - "tapi-path-computation" - description: "creates tapi.topology.CostCharacteristic" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" + - name: "local-id" in: "path" - description: "Id of path-comp-service" + description: "Id of topology-constraint" required: true type: "string" - - name: "cost-name" + - name: "value-name" in: "path" - description: "Id of cost-characteristic" + description: "Id of name" required: true type: "string" - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added or updated" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -3068,16 +2756,24 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.topology.CostCharacteristic" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "cost-name" + - name: "local-id" in: "path" - description: "Id of cost-characteristic" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" required: true type: "string" responses: @@ -3085,162 +2781,159 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/latency-characteristic/: - post: + /data/context/path-computation-context/path={uuid}/: + get: tags: - "tapi-path-computation" - description: "creates tapi.topology.LatencyCharacteristic" + summary: "returns tapi.path.computation.Path" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of path" required: true type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" responses: - 201: - description: "Object created" + 200: + description: "tapi.path.computation.Path" + schema: + $ref: "#/definitions/tapi.path.computation.Path" 400: description: "Internal error" - 409: - description: "Object already exists" - ? /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/ - : get: + /data/context/path-computation-context/path={uuid}/link={topology-uuid},{link-uuid}/: + get: tags: - "tapi-path-computation" - description: "returns tapi.topology.LatencyCharacteristic" + summary: "returns tapi.topology.LinkRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of path" required: true type: "string" - - name: "traffic-property-name" + - name: "topology-uuid" in: "path" - description: "Id of latency-characteristic" + description: "Id of link" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" required: true type: "string" responses: 200: - description: "tapi.topology.LatencyCharacteristic" + description: "tapi.topology.LinkRef" schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + $ref: "#/definitions/tapi.topology.LinkRef" 400: description: "Internal error" - post: + /data/context/path-computation-context/path={uuid}/name={value-name}/: + get: tags: - "tapi-path-computation" - description: "creates tapi.topology.LatencyCharacteristic" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of path" required: true type: "string" - - name: "traffic-property-name" + - name: "value-name" in: "path" - description: "Id of latency-characteristic" + description: "Id of name" required: true type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" responses: - 201: - description: "Object created" + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + /data/context/path-computation-context/path={uuid}/routing-constraint/: + get: tags: - "tapi-path-computation" - description: "creates or updates tapi.topology.LatencyCharacteristic" + summary: "returns tapi.path.computation.RoutingConstraint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" + description: "Id of path" required: true type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" responses: - 201: - description: "Object created" + 200: + description: "tapi.path.computation.RoutingConstraint" + schema: + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + /data/context/path-computation-context/path={uuid}/routing-constraint/cost-characteristic={cost-name}/: + get: tags: - "tapi-path-computation" - description: "removes tapi.topology.LatencyCharacteristic" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of path" required: true type: "string" - - name: "traffic-property-name" + - name: "cost-name" in: "path" - description: "Id of latency-characteristic" + description: "Id of cost-characteristic" required: true type: "string" responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/risk-diversity-characteristic/: - post: + /data/context/path-computation-context/path={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/: + get: tags: - "tapi-path-computation" - description: "creates tapi.topology.RiskCharacteristic" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of path" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" required: true type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" responses: - 201: - description: "Object created" + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" - 409: - description: "Object already exists" - ? /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/ - : get: + /data/context/path-computation-context/path={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/: + get: tags: - "tapi-path-computation" - description: "returns tapi.topology.RiskCharacteristic" + summary: "returns tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of path" required: true type: "string" - name: "risk-characteristic-name" @@ -3255,27 +2948,19 @@ paths: $ref: "#/definitions/tapi.topology.RiskCharacteristic" 400: description: "Internal error" + /data/context/service-interface-point/: post: tags: - - "tapi-path-computation" - description: "creates tapi.topology.RiskCharacteristic" + - "tapi-common" + summary: "creates tapi.common.ServiceInterfacePoint" + description: "none" parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added to list" + name: "tapi.common.ServiceInterfacePoint.body-param" + description: "tapi.common.ServiceInterfacePoint to be added to list" required: false schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" responses: 201: description: "Object created" @@ -3283,27 +2968,42 @@ paths: description: "Internal error" 409: description: "Object already exists" - put: + /data/context/service-interface-point={uuid}/: + get: tags: - - "tapi-path-computation" - description: "creates or updates tapi.topology.RiskCharacteristic" + - "tapi-common" + summary: "returns tapi.common.ServiceInterfacePoint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of service-interface-point" required: true type: "string" - - name: "risk-characteristic-name" + responses: + 200: + description: "tapi.common.ServiceInterfacePoint" + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + 400: + description: "Internal error" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.ServiceInterfacePoint" + description: "none" + parameters: + - name: "uuid" in: "path" - description: "Id of risk-diversity-characteristic" + description: "Id of service-interface-point" required: true type: "string" - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added or updated" + name: "tapi.common.ServiceInterfacePoint.body-param" + description: "tapi.common.ServiceInterfacePoint to be added or updated" required: false schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" responses: 201: description: "Object created" @@ -3313,17 +3013,13 @@ paths: description: "Object modified" delete: tags: - - "tapi-path-computation" - description: "removes tapi.topology.RiskCharacteristic" + - "tapi-common" + summary: "removes tapi.common.ServiceInterfacePoint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" + description: "Id of service-interface-point" required: true type: "string" responses: @@ -3331,521 +3027,237 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/: + /data/context/service-interface-point={uuid}/available-capacity/: get: tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.TopologyConstraint" + - "tapi-common" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of service-interface-point" required: true type: "string" responses: 200: - description: "tapi.path.computation.TopologyConstraint" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - post: + /data/context/service-interface-point={uuid}/available-capacity/total-size/: + get: tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.TopologyConstraint" + - "tapi-common" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of service-interface-point" required: true type: "string" - - in: "body" - name: "tapi.path.computation.TopologyConstraint.body-param" - description: "tapi.path.computation.TopologyConstraint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" responses: - 201: - description: "Object created" + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + /data/context/service-interface-point={uuid}/name/: + post: tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.TopologyConstraint" + - "tapi-common" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of service-interface-point" required: true type: "string" - in: "body" - name: "tapi.path.computation.TopologyConstraint.body-param" - description: "tapi.path.computation.TopologyConstraint to be added or updated" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" 400: description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.TopologyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/avoid-topology={topology-uuid}/: + 409: + description: "Object already exists" + /data/context/service-interface-point={uuid}/name={value-name}/: get: tags: - - "tapi-path-computation" - description: "returns tapi.topology.TopologyRef" + - "tapi-common" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of service-interface-point" required: true type: "string" - - name: "topology-uuid" + - name: "value-name" in: "path" - description: "Id of avoid-topology" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.topology.TopologyRef" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.topology.TopologyRef" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/exclude-link={topology-uuid},{link-uuid}/: - get: + put: tags: - - "tapi-path-computation" - description: "returns tapi.topology.LinkRef" + - "tapi-common" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of exclude-link" + description: "Id of service-interface-point" required: true type: "string" - - name: "link-uuid" + - name: "value-name" in: "path" - description: "Id of exclude-link" + description: "Id of name" required: true type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/exclude-node={topology-uuid},{node-uuid}/: - get: + 204: + description: "Object modified" + delete: tags: - - "tapi-path-computation" - description: "returns tapi.topology.NodeRef" + - "tapi-common" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of exclude-node" + description: "Id of service-interface-point" required: true type: "string" - - name: "node-uuid" + - name: "value-name" in: "path" - description: "Id of exclude-node" + description: "Id of name" required: true type: "string" responses: - 200: - description: "tapi.topology.NodeRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRef" 400: description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/exclude-path={path-uuid}/: + 204: + description: "Object deleted" + /data/context/service-interface-point={uuid}/total-potential-capacity/: get: tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathRef" + - "tapi-common" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "path-uuid" - in: "path" - description: "Id of exclude-path" + description: "Id of service-interface-point" required: true type: "string" responses: 200: - description: "tapi.path.computation.PathRef" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.path.computation.PathRef" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-link={topology-uuid},{link-uuid}/: + /data/context/service-interface-point={uuid}/total-potential-capacity/total-size/: get: tags: - - "tapi-path-computation" - description: "returns tapi.topology.LinkRef" + - "tapi-common" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of include-link" + description: "Id of service-interface-point" required: true type: "string" responses: 200: - description: "tapi.topology.LinkRef" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.topology.LinkRef" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-node={topology-uuid},{node-uuid}/: + /data/context/topology-context/: get: tags: - - "tapi-path-computation" - description: "returns tapi.topology.NodeRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-node" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of include-node" - required: true - type: "string" + - "tapi-topology" + summary: "returns tapi.topology.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: [] responses: 200: - description: "tapi.topology.NodeRef" + description: "tapi.topology.TopologyContext" schema: - $ref: "#/definitions/tapi.topology.NodeRef" + $ref: "#/definitions/tapi.topology.TopologyContext" 400: description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-path={path-uuid}/: - get: + post: tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathRef" + - "tapi-topology" + summary: "creates tapi.topology.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "path-uuid" - in: "path" - description: "Id of include-path" - required: true - type: "string" + - in: "body" + name: "tapi.topology.TopologyContext.body-param" + description: "tapi.topology.TopologyContext to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.topology.TopologyContext" responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-topology={topology-uuid}/: - get: + 409: + description: "Object already exists" + put: tags: - - "tapi-path-computation" - description: "returns tapi.topology.TopologyRef" + - "tapi-topology" + summary: "creates or updates tapi.topology.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.Path" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.Path" - schema: - $ref: "#/definitions/tapi.path.computation.Path" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LinkRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/name={value-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/routing-constraint/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.RoutingConstraint" - schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/routing-constraint/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - /data/context/service-interface-point/: - post: - tags: - - "tapi-common" - description: "creates tapi.common.ServiceInterfacePoint" - parameters: - - in: "body" - name: "tapi.common.ServiceInterfacePoint.body-param" - description: "tapi.common.ServiceInterfacePoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/service-interface-point={uuid}/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.ServiceInterfacePoint" - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.ServiceInterfacePoint.body-param" - description: "tapi.common.ServiceInterfacePoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - in: "body" - name: "tapi.common.ServiceInterfacePoint.body-param" - description: "tapi.common.ServiceInterfacePoint to be added or updated" + name: "tapi.topology.TopologyContext.body-param" + description: "tapi.topology.TopologyContext to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + $ref: "#/definitions/tapi.topology.TopologyContext" responses: 201: description: "Object created" @@ -3855,1988 +3267,186 @@ paths: description: "Object modified" delete: tags: - - "tapi-common" - description: "removes tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" + - "tapi-topology" + summary: "removes tapi.topology.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: [] responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/service-interface-point={uuid}/available-capacity/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/committed-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/total-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/name/: - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/service-interface-point={uuid}/name={value-name}/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/service-interface-point={uuid}/total-potential-capacity/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/total-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.TopologyContext" - parameters: [] - responses: - 200: - description: "tapi.topology.TopologyContext" - schema: - $ref: "#/definitions/tapi.topology.TopologyContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-topology" - description: "creates tapi.topology.TopologyContext" - parameters: - - in: "body" - name: "tapi.topology.TopologyContext.body-param" - description: "tapi.topology.TopologyContext to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.TopologyContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-topology" - description: "creates or updates tapi.topology.TopologyContext" - parameters: - - in: "body" - name: "tapi.topology.TopologyContext.body-param" - description: "tapi.topology.TopologyContext to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.TopologyContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-topology" - description: "removes tapi.topology.TopologyContext" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/topology-context/nw-topology-service/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NetworkTopologyService" - parameters: [] - responses: - 200: - description: "tapi.topology.NetworkTopologyService" - schema: - $ref: "#/definitions/tapi.topology.NetworkTopologyService" - 400: - description: "Internal error" - /data/context/topology-context/nw-topology-service/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/topology-context/nw-topology-service/topology={topology-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "topology-uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Topology" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Topology" - schema: - $ref: "#/definitions/tapi.topology.Topology" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Link" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Link" - schema: - $ref: "#/definitions/tapi.topology.Link" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/latency-characteristic={traffic-property-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/node-edge-point={topology-uuid},{node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/resilience-type/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.ResilienceType" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.ResilienceType" - schema: - $ref: "#/definitions/tapi.topology.ResilienceType" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/risk-characteristic={risk-characteristic-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/validation-mechanism={validation-mechanism}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.ValidationMechanism" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "validation-mechanism" - in: "path" - description: "Id of validation-mechanism" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.ValidationMechanism" - schema: - $ref: "#/definitions/tapi.topology.ValidationMechanism" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Node" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Node" - schema: - $ref: "#/definitions/tapi.topology.Node" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "aggregated-node-edge-point-node-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/encap-topology/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/latency-characteristic={traffic-property-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroup" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRuleGroup" - schema: - $ref: "#/definitions/tapi.topology.NodeRuleGroup" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/composed-rule-group={topology-uuid},{composed-rule-group-node-uuid},{composed-rule-group-node-rule-group-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroupRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of composed-rule-group" - required: true - type: "string" - - name: "composed-rule-group-node-uuid" - in: "path" - description: "Id of composed-rule-group" - required: true - type: "string" - - name: "composed-rule-group-node-rule-group-uuid" - in: "path" - description: "Id of composed-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRuleGroupRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/cost-characteristic={cost-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.InterRuleGroup" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" + /data/context/topology-context/nw-topology-service/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NetworkTopologyService" + description: "none" + parameters: [] responses: 200: - description: "tapi.topology.InterRuleGroup" + description: "tapi.topology.NetworkTopologyService" schema: - $ref: "#/definitions/tapi.topology.InterRuleGroup" + $ref: "#/definitions/tapi.topology.NetworkTopologyService" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/associated-node-rule-group={topology-uuid},{associated-node-rule-group-node-uuid},{associated-node-rule-group-node-rule-group-uuid}/ - : get: + /data/context/topology-context/nw-topology-service/name={value-name}/: + get: tags: - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroupRef" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of associated-node-rule-group" - required: true - type: "string" - - name: "associated-node-rule-group-node-uuid" - in: "path" - description: "Id of associated-node-rule-group" - required: true - type: "string" - - name: "associated-node-rule-group-node-rule-group-uuid" + - name: "value-name" in: "path" - description: "Id of associated-node-rule-group" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.topology.NodeRuleGroupRef" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/ - : get: + /data/context/topology-context/nw-topology-service/topology={topology-uuid}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.Capacity" + summary: "returns tapi.topology.TopologyRef" + description: "none" parameters: - - name: "uuid" + - name: "topology-uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" responses: 200: - description: "tapi.common.Capacity" + description: "tapi.topology.TopologyRef" schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.topology.TopologyRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/ - : get: + /data/context/topology-context/topology={uuid}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" + summary: "returns tapi.topology.Topology" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.topology.Topology" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.topology.Topology" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ - : get: + /data/context/topology-context/topology={uuid}/boundary-node-edge-point={topology-uuid},{node-uuid},{node-edge-point-uuid}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "node-uuid" + - name: "topology-uuid" in: "path" - description: "Id of node" + description: "Id of boundary-node-edge-point" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of boundary-node-edge-point" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of boundary-node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.NodeEdgePointRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: + /data/context/topology-context/topology={uuid}/link={link-uuid}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.Link" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" + - name: "link-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of link" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.Link" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.Link" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ - : get: + /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" + - name: "link-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of link" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ - : get: + /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/total-size/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" + - name: "link-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of link" required: true type: "string" responses: @@ -5846,177 +3456,152 @@ paths: $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/total-size/ - : get: + /data/context/topology-context/topology={uuid}/link={link-uuid}/cost-characteristic={cost-name}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" + - name: "link-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of link" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "cost-name" in: "path" - description: "Id of inter-rule-group" + description: "Id of cost-characteristic" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.CostCharacteristic" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.CostCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/cost-characteristic={cost-name}/ - : get: + /data/context/topology-context/topology={uuid}/link={link-uuid}/latency-characteristic={traffic-property-name}/: + get: tags: - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" + - name: "link-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of link" required: true type: "string" - - name: "cost-name" + - name: "traffic-property-name" in: "path" - description: "Id of cost-characteristic" + description: "Id of latency-characteristic" required: true type: "string" responses: 200: - description: "tapi.topology.CostCharacteristic" + description: "tapi.topology.LatencyCharacteristic" schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/latency-characteristic={traffic-property-name}/ - : get: + /data/context/topology-context/topology={uuid}/link={link-uuid}/name={value-name}/: + get: tags: - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" + - name: "link-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of link" required: true type: "string" - - name: "traffic-property-name" + - name: "value-name" in: "path" - description: "Id of latency-characteristic" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.topology.LatencyCharacteristic" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/name={value-name}/ + ? /data/context/topology-context/topology={uuid}/link={link-uuid}/node-edge-point={topology-uuid},{node-uuid},{node-edge-point-uuid}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "node-uuid" + - name: "link-uuid" in: "path" - description: "Id of node" + description: "Id of link" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "topology-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "node-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "value-name" + - name: "node-edge-point-uuid" in: "path" - description: "Id of name" + description: "Id of node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.topology.NodeEdgePointRef" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ - : get: + /data/context/topology-context/topology={uuid}/link={link-uuid}/risk-characteristic={risk-characteristic-name}/: + get: tags: - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" + - name: "link-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of link" required: true type: "string" - name: "risk-characteristic-name" @@ -6031,73 +3616,98 @@ paths: $ref: "#/definitions/tapi.topology.RiskCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/ - : get: + /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/: + get: tags: - "tapi-topology" - description: "returns tapi.topology.Rule" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" + - name: "link-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of link" required: true type: "string" - - name: "inter-rule-group-uuid" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/total-size/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of topology" required: true type: "string" - - name: "local-id" + - name: "link-uuid" in: "path" - description: "Id of rule" + description: "Id of link" required: true type: "string" responses: 200: - description: "tapi.topology.Rule" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.topology.Rule" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/name={value-name}/ - : get: + /data/context/topology-context/topology={uuid}/link={link-uuid}/validation-mechanism={validation-mechanism}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.topology.ValidationMechanism" + description: "Provides details of the specific validation mechanism(s) used\ + \ to confirm the presence of an intended topologicalEntity." parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" + - name: "link-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of link" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "validation-mechanism" in: "path" - description: "Id of inter-rule-group" + description: "Id of validation-mechanism" required: true type: "string" - - name: "local-id" + responses: + 200: + description: "tapi.topology.ValidationMechanism" + schema: + $ref: "#/definitions/tapi.topology.ValidationMechanism" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" in: "path" - description: "Id of rule" + description: "Id of topology" required: true type: "string" - name: "value-name" @@ -6112,11 +3722,12 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.Capacity" + summary: "returns tapi.topology.Node" + description: "none" parameters: - name: "uuid" in: "path" @@ -6128,28 +3739,19 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" responses: 200: - description: "tapi.common.Capacity" + description: "tapi.topology.Node" schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.topology.Node" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -6161,28 +3763,34 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "topology-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of aggregated-node-edge-point" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "aggregated-node-edge-point-node-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.topology.NodeEdgePointRef" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" @@ -6194,14 +3802,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/total-size/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of topology" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "node-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of node" required: true type: "string" responses: @@ -6211,11 +3834,13 @@ paths: $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/cost-characteristic={cost-name}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" @@ -6227,28 +3852,24 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" + - name: "cost-name" in: "path" - description: "Id of inter-rule-group" + description: "Id of cost-characteristic" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.CostCharacteristic" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.CostCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/encap-topology/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.TopologyRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -6260,28 +3881,51 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + responses: + 200: + description: "tapi.topology.TopologyRef" + schema: + $ref: "#/definitions/tapi.topology.TopologyRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/latency-characteristic={traffic-property-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of topology" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "node-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of node" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.LatencyCharacteristic" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/name={value-name}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -6293,28 +3937,24 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" + - name: "value-name" in: "path" - description: "Id of inter-rule-group" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/total-size/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.NodeEdgePoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -6326,28 +3966,24 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.NodeEdgePoint" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.NodeEdgePoint" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/latency-characteristic={traffic-property-name}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{aggregated-node-edge-point-node-edge-point-uuid}/ : get: tags: - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -6359,28 +3995,39 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "aggregated-node-edge-point-node-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of aggregated-node-edge-point" required: true type: "string" - - name: "traffic-property-name" + - name: "aggregated-node-edge-point-node-edge-point-uuid" in: "path" - description: "Id of latency-characteristic" + description: "Id of aggregated-node-edge-point" required: true type: "string" responses: 200: - description: "tapi.topology.LatencyCharacteristic" + description: "tapi.topology.NodeEdgePointRef" schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/name={value-name}/: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-capacity/: get: tags: - "tapi-topology" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" @@ -6392,28 +4039,25 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "value-name" + - name: "node-edge-point-uuid" in: "path" - description: "Id of name" + description: "Id of node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/node-edge-point={topology-uuid},{node-edge-point-node-uuid},{node-edge-point-uuid}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-capacity/total-size/ : get: tags: - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -6425,21 +4069,6 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-edge-point-node-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - name: "node-edge-point-uuid" in: "path" description: "Id of node-edge-point" @@ -6447,16 +4076,17 @@ paths: type: "string" responses: 200: - description: "tapi.topology.NodeEdgePointRef" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-cep-layer-protocol={layer-protocol-qualifier}/ : get: tags: - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" + summary: "returns tapi.topology.NepLayerProtocolCapability" + description: "none" parameters: - name: "uuid" in: "path" @@ -6468,28 +4098,31 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "risk-characteristic-name" + - name: "layer-protocol-qualifier" in: "path" - description: "Id of risk-characteristic" + description: "Id of available-cep-layer-protocol" required: true type: "string" responses: 200: - description: "tapi.topology.RiskCharacteristic" + description: "tapi.topology.NepLayerProtocolCapability" schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" + $ref: "#/definitions/tapi.topology.NepLayerProtocolCapability" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/: - get: + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/mapped-service-interface-point={service-interface-point-uuid}/ + : get: tags: - "tapi-topology" - description: "returns tapi.topology.Rule" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "NodeEdgePoint mapped to more than ServiceInterfacePoint (slicing/virtualizing)\ + \ or a ServiceInterfacePoint mapped to more than one NodeEdgePoint (load balancing/Resilience)\ + \ should be considered experimental" parameters: - name: "uuid" in: "path" @@ -6501,28 +4134,31 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "local-id" + - name: "service-interface-point-uuid" in: "path" - description: "Id of rule" + description: "Id of mapped-service-interface-point" required: true type: "string" responses: 200: - description: "tapi.topology.Rule" + description: "tapi.common.ServiceInterfacePointRef" schema: - $ref: "#/definitions/tapi.topology.Rule" + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/name={value-name}/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/name={value-name}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -6534,14 +4170,9 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "local-id" + - name: "node-edge-point-uuid" in: "path" - description: "Id of rule" + description: "Id of node-edge-point" required: true type: "string" - name: "value-name" @@ -6556,11 +4187,13 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/total-potential-capacity/ : get: tags: - "tapi-topology" - description: "returns tapi.common.Capacity" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" @@ -6572,9 +4205,9 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" responses: @@ -6584,11 +4217,13 @@ paths: $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/total-potential-capacity/total-size/ : get: tags: - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -6600,23 +4235,24 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.NodeRuleGroup" + description: "none" parameters: - name: "uuid" in: "path" @@ -6635,16 +4271,17 @@ paths: type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.NodeRuleGroup" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.NodeRuleGroup" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" @@ -6663,16 +4300,18 @@ paths: type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/total-size/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -6696,11 +4335,12 @@ paths: $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/composed-rule-group={topology-uuid},{composed-rule-group-node-uuid},{composed-rule-group-node-rule-group-uuid}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.NodeRuleGroupRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -6717,18 +4357,35 @@ paths: description: "Id of node-rule-group" required: true type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of composed-rule-group" + required: true + type: "string" + - name: "composed-rule-group-node-uuid" + in: "path" + description: "Id of composed-rule-group" + required: true + type: "string" + - name: "composed-rule-group-node-rule-group-uuid" + in: "path" + description: "Id of composed-rule-group" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.NodeRuleGroupRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/total-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/cost-characteristic={cost-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" @@ -6745,18 +4402,24 @@ paths: description: "Id of node-rule-group" required: true type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.CostCharacteristic" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.CostCharacteristic" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/: - get: + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/ + : get: tags: - "tapi-topology" - description: "returns tapi.topology.NodeEdgePoint" + summary: "returns tapi.topology.InterRuleGroup" + description: "none" parameters: - name: "uuid" in: "path" @@ -6768,23 +4431,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of inter-rule-group" required: true type: "string" responses: 200: - description: "tapi.topology.NodeEdgePoint" + description: "tapi.topology.InterRuleGroup" schema: - $ref: "#/definitions/tapi.topology.NodeEdgePoint" + $ref: "#/definitions/tapi.topology.InterRuleGroup" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/associated-node-rule-group={topology-uuid},{associated-node-rule-group-node-uuid},{associated-node-rule-group-node-rule-group-uuid}/ : get: tags: - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" + summary: "returns tapi.topology.NodeRuleGroupRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -6796,38 +4465,44 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of inter-rule-group" required: true type: "string" - name: "topology-uuid" in: "path" - description: "Id of aggregated-node-edge-point" + description: "Id of associated-node-rule-group" required: true type: "string" - - name: "aggregated-node-edge-point-node-uuid" + - name: "associated-node-rule-group-node-uuid" in: "path" - description: "Id of aggregated-node-edge-point" + description: "Id of associated-node-rule-group" required: true type: "string" - - name: "node-edge-point-uuid" + - name: "associated-node-rule-group-node-rule-group-uuid" in: "path" - description: "Id of aggregated-node-edge-point" + description: "Id of associated-node-rule-group" required: true type: "string" responses: 200: - description: "tapi.topology.NodeEdgePointRef" + description: "tapi.topology.NodeRuleGroupRef" schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/ : get: tags: - "tapi-topology" - description: "returns tapi.common.Capacity" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" @@ -6839,9 +4514,14 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of inter-rule-group" required: true type: "string" responses: @@ -6851,11 +4531,13 @@ paths: $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/total-size/ : get: tags: - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -6867,23 +4549,30 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of inter-rule-group" required: true type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/cost-characteristic={cost-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" @@ -6895,51 +4584,35 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of topology" + description: "Id of node-rule-group" required: true type: "string" - - name: "node-uuid" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of node" + description: "Id of inter-rule-group" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "cost-name" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of cost-characteristic" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.CostCharacteristic" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.CostCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/latency-characteristic={traffic-property-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" @@ -6951,23 +4624,36 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "traffic-property-name" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of latency-characteristic" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.LatencyCharacteristic" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/name={value-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -6979,23 +4665,35 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "value-name" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/total-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." parameters: - name: "uuid" in: "path" @@ -7007,23 +4705,34 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "risk-characteristic-name" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of risk-characteristic" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.RiskCharacteristic" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.RiskCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/mapped-service-interface-point={service-interface-point-uuid}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.ServiceInterfacePointRef" + summary: "returns tapi.topology.Rule" + description: "none" parameters: - name: "uuid" in: "path" @@ -7035,28 +4744,36 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of inter-rule-group" required: true type: "string" - - name: "service-interface-point-uuid" + - name: "local-id" in: "path" - description: "Id of mapped-service-interface-point" + description: "Id of rule" required: true type: "string" responses: 200: - description: "tapi.common.ServiceInterfacePointRef" + description: "tapi.topology.Rule" schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + $ref: "#/definitions/tapi.topology.Rule" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/name={value-name}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/name={value-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -7068,9 +4785,19 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "local-id" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of rule" required: true type: "string" - name: "value-name" @@ -7085,11 +4812,13 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/ : get: tags: - "tapi-topology" - description: "returns tapi.common.Capacity" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" @@ -7101,9 +4830,14 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of inter-rule-group" required: true type: "string" responses: @@ -7113,11 +4847,13 @@ paths: $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/total-size/ : get: tags: - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -7129,23 +4865,30 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of inter-rule-group" required: true type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/latency-characteristic={traffic-property-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" @@ -7157,23 +4900,31 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "traffic-property-name" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of latency-characteristic" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.LatencyCharacteristic" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/name={value-name}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -7185,23 +4936,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "value-name" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/node-edge-point={topology-uuid},{node-edge-point-node-uuid},{node-edge-point-uuid}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -7213,51 +4970,40 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-rule-group" required: true type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" + - name: "topology-uuid" in: "path" - description: "Id of topology" + description: "Id of node-edge-point" required: true type: "string" - - name: "node-uuid" + - name: "node-edge-point-node-uuid" in: "path" - description: "Id of node" + description: "Id of node-edge-point" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.NodeEdgePointRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/total-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." parameters: - name: "uuid" in: "path" @@ -7269,23 +5015,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "risk-characteristic-name" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of risk-characteristic" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.RiskCharacteristic" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.RiskCharacteristic" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/: get: tags: - "tapi-topology" - description: "returns tapi.common.Capacity" + summary: "returns tapi.topology.Rule" + description: "none" parameters: - name: "uuid" in: "path" @@ -7297,41 +5049,31 @@ paths: description: "Id of node" required: true type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of topology" + description: "Id of node-rule-group" required: true type: "string" - - name: "node-uuid" + - name: "local-id" in: "path" - description: "Id of node" + description: "Id of rule" required: true type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.topology.Rule" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.topology.Rule" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/name={value-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -7343,18 +5085,35 @@ paths: description: "Id of node" required: true type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" @@ -7366,18 +5125,25 @@ paths: description: "Id of node" required: true type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/total-size/ + : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -7389,6 +5155,11 @@ paths: description: "Id of node" required: true type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" responses: 200: description: "tapi.common.CapacityValue" @@ -7396,11 +5167,13 @@ paths: $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" @@ -7414,16 +5187,18 @@ paths: type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/total-size/: get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -7446,6 +5221,8 @@ paths: post: tags: - "tapi-path-computation" + summary: "operates on tapi.path.computation.ComputeP2PPath" + description: "operates on tapi.path.computation.ComputeP2PPath" parameters: - in: "body" name: "tapi.path.computation.computep2ppath.Input.body-param" @@ -7467,6 +5244,8 @@ paths: post: tags: - "tapi-notification" + summary: "operates on tapi.notification.CreateNotificationSubscriptionService" + description: "operates on tapi.notification.CreateNotificationSubscriptionService" parameters: - in: "body" name: "tapi.notification.createnotificationsubscriptionservice.Input.body-param" @@ -7488,6 +5267,8 @@ paths: post: tags: - "tapi-notification" + summary: "operates on tapi.notification.DeleteNotificationSubscriptionService" + description: "operates on tapi.notification.DeleteNotificationSubscriptionService" parameters: - in: "body" name: "tapi.notification.deletenotificationsubscriptionservice.Input.body-param" @@ -7497,10 +5278,6 @@ paths: input: $ref: "#/definitions/tapi.notification.deletenotificationsubscriptionservice.Input" responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.DeleteNotificationSubscriptionService" 201: description: "No response" 400: @@ -7509,6 +5286,8 @@ paths: post: tags: - "tapi-path-computation" + summary: "operates on tapi.path.computation.DeleteP2PPath" + description: "operates on tapi.path.computation.DeleteP2PPath" parameters: - in: "body" name: "tapi.path.computation.deletep2ppath.Input.body-param" @@ -7530,6 +5309,8 @@ paths: post: tags: - "tapi-topology" + summary: "operates on tapi.topology.GetLinkDetails" + description: "operates on tapi.topology.GetLinkDetails" parameters: - in: "body" name: "tapi.topology.getlinkdetails.Input.body-param" @@ -7551,6 +5332,8 @@ paths: post: tags: - "tapi-topology" + summary: "operates on tapi.topology.GetNodeDetails" + description: "operates on tapi.topology.GetNodeDetails" parameters: - in: "body" name: "tapi.topology.getnodedetails.Input.body-param" @@ -7572,6 +5355,8 @@ paths: post: tags: - "tapi-topology" + summary: "operates on tapi.topology.GetNodeEdgePointDetails" + description: "operates on tapi.topology.GetNodeEdgePointDetails" parameters: - in: "body" name: "tapi.topology.getnodeedgepointdetails.Input.body-param" @@ -7593,6 +5378,8 @@ paths: post: tags: - "tapi-notification" + summary: "operates on tapi.notification.GetNotificationList" + description: "operates on tapi.notification.GetNotificationList" parameters: - in: "body" name: "tapi.notification.getnotificationlist.Input.body-param" @@ -7614,6 +5401,8 @@ paths: post: tags: - "tapi-notification" + summary: "operates on tapi.notification.GetNotificationSubscriptionServiceDetails" + description: "operates on tapi.notification.GetNotificationSubscriptionServiceDetails" parameters: - in: "body" name: "tapi.notification.getnotificationsubscriptionservicedetails.Input.body-param" @@ -7649,6 +5438,8 @@ paths: post: tags: - "tapi-common" + summary: "operates on tapi.common.GetServiceInterfacePointDetails" + description: "operates on tapi.common.GetServiceInterfacePointDetails" parameters: - in: "body" name: "tapi.common.getserviceinterfacepointdetails.Input.body-param" @@ -7698,6 +5489,8 @@ paths: post: tags: - "tapi-topology" + summary: "operates on tapi.topology.GetTopologyDetails" + description: "operates on tapi.topology.GetTopologyDetails" parameters: - in: "body" name: "tapi.topology.gettopologydetails.Input.body-param" @@ -7733,6 +5526,8 @@ paths: post: tags: - "tapi-path-computation" + summary: "operates on tapi.path.computation.OptimizeP2PPath" + description: "operates on tapi.path.computation.OptimizeP2PPath" parameters: - in: "body" name: "tapi.path.computation.optimizep2ppath.Input.body-param" @@ -7754,6 +5549,8 @@ paths: post: tags: - "tapi-notification" + summary: "operates on tapi.notification.UpdateNotificationSubscriptionService" + description: "operates on tapi.notification.UpdateNotificationSubscriptionService" parameters: - in: "body" name: "tapi.notification.updatenotificationsubscriptionservice.Input.body-param" @@ -7775,6 +5572,8 @@ paths: post: tags: - "tapi-common" + summary: "operates on tapi.common.UpdateServiceInterfacePoint" + description: "operates on tapi.common.UpdateServiceInterfacePoint" parameters: - in: "body" name: "tapi.common.updateserviceinterfacepoint.Input.body-param" @@ -7806,45 +5605,9 @@ definitions: enum: - "LOCKED" - "UNLOCKED" - tapi.common.BandwidthProfile: - type: "object" - properties: - committed-information-rate: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - coupling-flag: - type: "boolean" - description: "none" - default: false - bw-profile-type: - description: "none" - $ref: "#/definitions/tapi.common.BandwidthProfileType" - peak-information-rate: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - committed-burst-size: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - peak-burst-size: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - color-aware: - type: "boolean" - description: "none" - default: false - tapi.common.BandwidthProfileType: - type: "string" - enum: - - "MEF_10.x" - - "RFC_2697" - - "RFC_2698" - - "RFC_4115" tapi.common.Capacity: type: "object" properties: - bandwidth-profile: - description: "none" - $ref: "#/definitions/tapi.common.BandwidthProfile" total-size: description: "Total capacity of the TopologicalEntity in MB/s. In case of\ \ bandwidthProfile, this is expected to same as the committedInformationRate." @@ -7885,8 +5648,8 @@ definitions: tapi.common.Context: allOf: - $ref: "#/definitions/tapi.common.TapiContext" - - $ref: "#/definitions/tapi.notification.ContextAugmentation1" - - $ref: "#/definitions/tapi.path.computation.ContextAugmentation2" + - $ref: "#/definitions/tapi.notification.ContextAugmentation2" + - $ref: "#/definitions/tapi.path.computation.ContextAugmentation1" - $ref: "#/definitions/tapi.topology.ContextAugmentation3" tapi.common.DirectiveValue: type: "string" @@ -7917,21 +5680,21 @@ definitions: properties: name: type: "array" - description: "List of names. A property of an entity with a value that is\ - \ unique in some namespace but may change during the life of the entity.\ - \ A name carries no semantics with respect to the purpose of the entity." + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." items: $ref: "#/definitions/tapi.common.NameAndValue" uuid: type: "string" description: "UUID: An identifier that is universally unique within an identifier\ - \ space, where the identifier space is itself globally unique, and immutable.\ - \ An UUID carries no semantics with respect to the purpose or state of the\ - \ entity.\r\n UUID here uses string representation as\ - \ defined in RFC 4122. The canonical representation uses lowercase characters.\r\ - \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ - \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ - \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a UUID\ + \ in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.common.LayerProtocolName: type: "string" enum: @@ -7952,9 +5715,9 @@ definitions: properties: name: type: "array" - description: "List of names. A property of an entity with a value that is\ - \ unique in some namespace but may change during the life of the entity.\ - \ A name carries no semantics with respect to the purpose of the entity." + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." items: $ref: "#/definitions/tapi.common.NameAndValue" local-id: @@ -8007,7 +5770,7 @@ definitions: $ref: "#/definitions/tapi.common.LayerProtocolName" description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ \ termination and adaptation functions of one or more transport layers. \r\ - \n The structure of LTP supports all transport protocols including\ + \n The structure of LTP supports all transport protocols including\ \ circuit and packet forms." tapi.common.ServiceInterfacePointRef: type: "object" @@ -8041,11 +5804,11 @@ definitions: type: "object" properties: termination-direction: - description: "The overall directionality of the LP. \r\n \ - \ - A BIDIRECTIONAL LP will have some SINK and/or SOURCE flowss.\r\n \ - \ - A SINK LP can only contain elements with SINK flows\ - \ or CONTRA_DIRECTION_SOURCE flows\r\n - A SOURCE LP\ - \ can only contain SOURCE flows or CONTRA_DIRECTION_SINK flows" + description: "The overall directionality of the LP. \r\n -\ + \ A BIDIRECTIONAL LP will have some SINK and/or SOURCE flowss.\r\n \ + \ - A SINK LP can only contain elements with SINK flows or CONTRA_DIRECTION_SOURCE\ + \ flows\r\n - A SOURCE LP can only contain SOURCE flows or\ + \ CONTRA_DIRECTION_SINK flows" $ref: "#/definitions/tapi.common.TerminationDirection" termination-state: description: "Indicates whether the layer is terminated and if so how." @@ -8060,12 +5823,28 @@ definitions: - "TERMINATED_BIDIRECTIONAL" - "LT_PERMENANTLY_TERMINATED" - "TERMINATION_STATE_UNKNOWN" - tapi.common.getserviceinterfacepointdetails.Input: + tapi.common.TimeRange: type: "object" properties: - sip-id-or-name: + end-time: + type: "string" + description: "none" + start-time: type: "string" description: "none" + tapi.common.getserviceinterfacepointdetails.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.common.getserviceinterfacepointdetails.Output: type: "object" properties: @@ -8083,29 +5862,20 @@ definitions: tapi.common.updateserviceinterfacepoint.Input: type: "object" properties: - sip-id-or-name: - type: "string" - description: "none" - state: - description: "none" - $ref: "#/definitions/tapi.common.AdministrativeState" - tapi.notification.AlarmInfo: - type: "object" - properties: - perceived-severity: - description: "none" - $ref: "#/definitions/tapi.notification.PerceivedSeverityType" - probable-cause: + uuid: type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + state: description: "none" - service-affecting: - description: "none" - $ref: "#/definitions/tapi.notification.ServiceAffecting" - is-transient: - type: "boolean" - description: "none" - default: false - tapi.notification.ContextAugmentation1: + $ref: "#/definitions/tapi.common.AdministrativeState" + tapi.notification.ContextAugmentation2: type: "object" properties: notification-context: @@ -8119,11 +5889,6 @@ definitions: properties: output: $ref: "#/definitions/tapi.notification.createnotificationsubscriptionservice.Output" - tapi.notification.DeleteNotificationSubscriptionService: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.notification.deletenotificationsubscriptionservice.Output" tapi.notification.GetNotificationList: type: "object" properties: @@ -8162,8 +5927,8 @@ definitions: - type: "object" properties: target-object-type: + type: "string" description: "none" - $ref: "#/definitions/tapi.notification.ObjectType" additional-text: type: "string" description: "none" @@ -8179,18 +5944,15 @@ definitions: type: "integer" format: "int32" description: "A monotonous increasing sequence number associated with the\ - \ notification.\r\n The exact semantics of how this\ - \ sequence number is assigned (per channel or subscription or source or\ - \ system) is left undefined." - tca-info: - description: "none" - $ref: "#/definitions/tapi.notification.TcaInfo" + \ notification.\r\n The exact semantics of how this sequence\ + \ number is assigned (per channel or subscription or source or system)\ + \ is left undefined." target-object-identifier: type: "string" description: "none" notification-type: + type: "string" description: "none" - $ref: "#/definitions/tapi.notification.NotificationType" target-object-name: type: "array" description: "none" @@ -8202,9 +5964,9 @@ definitions: source-indicator: description: "none" $ref: "#/definitions/tapi.notification.SourceIndicator" - alarm-info: + layer-protocol-qualifier: + type: "string" description: "none" - $ref: "#/definitions/tapi.notification.AlarmInfo" changed-attributes: type: "array" description: "none" @@ -8224,9 +5986,9 @@ definitions: stream-address: type: "string" description: "The address/location/URI of the channel/stream to which the\ - \ subscribed notifications are published.\r\n This\ - \ specifics of this is typically dependent on the implementation protocol\ - \ & mechanism and hence is typed as a string." + \ subscribed notifications are published.\r\n This specifics\ + \ of this is typically dependent on the implementation protocol & mechanism\ + \ and hence is typed as a string." description: "none" tapi.notification.NotificationContext: type: "object" @@ -8261,68 +6023,16 @@ definitions: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.ObjectType" + type: "string" supported-notification-types: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.NotificationType" + type: "string" subscription-filter: description: "none" $ref: "#/definitions/tapi.notification.SubscriptionFilter" description: "none" - tapi.notification.NotificationType: - type: "string" - enum: - - "OBJECT_CREATION" - - "OBJECT_DELETION" - - "ATTRIBUTE_VALUE_CHANGE" - - "ALARM_EVENT" - - "THRESHOLD_CROSSING_ALERT" - tapi.notification.ObjectType: - type: "string" - enum: - - "TOPOLOGY" - - "NODE" - - "LINK" - - "CONNECTION" - - "PATH" - - "CONNECTIVITY_SERVICE" - - "VIRTUAL_NETWORK_SERVICE" - - "PATH_COMPUTATION_SERVICE" - - "NODE_EDGE_POINT" - - "SERVICE_INTERFACE_POINT" - - "CONNECTION_END_POINT" - - "MAINTENANCE_ENTITY_GROUP" - - "MAINTENANCE_ENTITY" - - "MEG_END_POINT" - - "MEG_INTERMEDIATE_POINT" - - "SWITCH_CONTROL" - - "SWITCH" - - "ROUTE" - - "NODE_RULE_GROUP" - - "INTER_RULE_GROUP" - - "RULE" - - "OAM_JOB" - tapi.notification.PerceivedSeverityType: - type: "string" - enum: - - "CRITICAL" - - "MAJOR" - - "MINOR" - - "WARNING" - - "CLEARED" - tapi.notification.PerceivedTcaSeverity: - type: "string" - enum: - - "WARNING" - - "CLEAR" - tapi.notification.ServiceAffecting: - type: "string" - enum: - - "SERVICE_AFFECTING" - - "NOT_SERVICE_AFFECTING" - - "UNKNOWN" tapi.notification.SourceIndicator: type: "string" enum: @@ -8338,7 +6048,7 @@ definitions: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.NotificationType" + type: "string" requested-object-identifier: type: "array" description: "none" @@ -8359,46 +6069,13 @@ definitions: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.ObjectType" + type: "string" description: "none" tapi.notification.SubscriptionState: type: "string" enum: - "SUSPENDED" - "ACTIVE" - tapi.notification.TcaInfo: - type: "object" - properties: - threshold-crossing: - description: "none" - $ref: "#/definitions/tapi.notification.ThresholdCrossingType" - threshold-parameter: - type: "string" - description: "none" - is-transient: - type: "boolean" - description: "none" - default: false - threshold-value: - type: "integer" - format: "int32" - description: "none" - perceived-severity: - description: "none" - $ref: "#/definitions/tapi.notification.PerceivedTcaSeverity" - suspect-interval-flag: - type: "boolean" - description: "none" - default: false - measurement-interval: - type: "string" - description: "none" - tapi.notification.ThresholdCrossingType: - type: "string" - enum: - - "THRESHOLD_ABOVE" - - "THRESHOLD_BELOW" - - "CLEARED" tapi.notification.UpdateNotificationSubscriptionService: type: "object" properties: @@ -8410,6 +6087,23 @@ definitions: subscription-state: description: "none" $ref: "#/definitions/tapi.notification.SubscriptionState" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" subscription-filter: description: "none" $ref: "#/definitions/tapi.notification.SubscriptionFilter" @@ -8422,24 +6116,33 @@ definitions: tapi.notification.deletenotificationsubscriptionservice.Input: type: "object" properties: - subscription-id-or-name: + uuid: type: "string" - description: "none" - tapi.notification.deletenotificationsubscriptionservice.Output: - type: "object" - properties: - subscription-service: - description: "none" - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.notification.getnotificationlist.Input: type: "object" properties: - time-period: - type: "string" - description: "none" - subscription-id-or-name: - type: "string" + time-range: description: "none" + $ref: "#/definitions/tapi.common.TimeRange" + subscription-id: + type: "string" + description: "UUID of the associated Notification Subscription Service: An\ + \ identifier that is universally unique within an identifier space, where\ + \ the identifier space is itself globally unique, and immutable.\r\n \ + \ An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.notification.getnotificationlist.Output: type: "object" properties: @@ -8451,9 +6154,16 @@ definitions: tapi.notification.getnotificationsubscriptionservicedetails.Input: type: "object" properties: - subscription-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.notification.getnotificationsubscriptionservicedetails.Output: type: "object" properties: @@ -8475,24 +6185,38 @@ definitions: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.ObjectType" + type: "string" supported-notification-types: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.NotificationType" + type: "string" tapi.notification.updatenotificationsubscriptionservice.Input: type: "object" properties: subscription-state: description: "none" $ref: "#/definitions/tapi.notification.SubscriptionState" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" subscription-filter: description: "none" $ref: "#/definitions/tapi.notification.SubscriptionFilter" - subscription-id-or-name: - type: "string" - description: "none" tapi.notification.updatenotificationsubscriptionservice.Output: type: "object" properties: @@ -8504,7 +6228,7 @@ definitions: properties: output: $ref: "#/definitions/tapi.path.computation.computep2ppath.Output" - tapi.path.computation.ContextAugmentation2: + tapi.path.computation.ContextAugmentation1: type: "object" properties: path-computation-context: @@ -8573,8 +6297,10 @@ definitions: - type: "object" properties: topology-constraint: + type: "array" description: "none" - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" path: type: "array" description: "none" @@ -8588,12 +6314,18 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" routing-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.RoutingConstraint" optimization-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" + direction: + description: "none" + $ref: "#/definitions/tapi.common.ForwardingDirection" description: "none" tapi.path.computation.PathObjectiveFunction: allOf: @@ -8658,16 +6390,16 @@ definitions: description: "none" $ref: "#/definitions/tapi.common.Capacity" description: "The association of the FC to LTPs is made via EndPoints.\r\n \ - \ The EndPoint (EP) object class models the access to the FC\ - \ function. \r\n The traffic forwarding between the associated\ - \ EPs of the FC depends upon the type of FC and may be associated with FcSwitch\ - \ object instances. \r\n In cases where there is resilience\ - \ the EndPoint may convey the resilience role of the access to the FC. \r\n\ - \ It can represent a protected (resilient/reliable) point or\ - \ a protecting (unreliable working or protection) point.\r\n \ - \ The EP replaces the Protection Unit of a traditional protection model.\ - \ \r\n The ForwadingConstruct can be considered as a component\ - \ and the EndPoint as a Port on that component" + \ The EndPoint (EP) object class models the access to the FC function.\ + \ \r\n The traffic forwarding between the associated EPs of the\ + \ FC depends upon the type of FC and may be associated with FcSwitch object\ + \ instances. \r\n In cases where there is resilience the EndPoint\ + \ may convey the resilience role of the access to the FC. \r\n \ + \ It can represent a protected (resilient/reliable) point or a protecting\ + \ (unreliable working or protection) point.\r\n The EP replaces\ + \ the Protection Unit of a traditional protection model. \r\n The\ + \ ForwadingConstruct can be considered as a component and the EndPoint as\ + \ a Port on that component" tapi.path.computation.RouteObjectiveFunction: type: "string" enum: @@ -8685,6 +6417,9 @@ definitions: type: "boolean" description: "To distinguish if the resources are to be exclusive to the service" default: true + tolerable-impact: + type: "string" + description: "Grades of maximum tolerable disruption to traffic." diversity-policy: description: "none" $ref: "#/definitions/tapi.path.computation.DiversityPolicy" @@ -8708,78 +6443,100 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.topology.RiskCharacteristic" - route-direction: - description: "none" - $ref: "#/definitions/tapi.common.ForwardingDirection" tapi.path.computation.TopologyConstraint: - type: "object" - properties: - include-node: - type: "array" - description: "This is a loose constraint - that is it is unordered and could\ - \ be a partial list" - items: - $ref: "#/definitions/tapi.topology.NodeRef" - exclude-link: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.LinkRef" - avoid-topology: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.TopologyRef" - exclude-path: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.path.computation.PathRef" - include-link: - type: "array" - description: "This is a loose constraint - that is it is unordered and could\ - \ be a partial list " - items: - $ref: "#/definitions/tapi.topology.LinkRef" - preferred-transport-layer: - type: "array" - description: "soft constraint requested by client to indicate the layer(s)\ - \ of transport connection that it prefers to carry the service. This could\ - \ be same as the service layer or one of the supported server layers" - items: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + include-node: + type: "string" + description: "This is a loose constraint - that is it is unordered and could\ + \ be a partial list" + exclude-link: + type: "string" + description: "none" + avoid-topology: + type: "string" + description: "none" + exclude-path: + type: "string" + description: "none" + include-topology: + type: "string" + description: "none" + include-path: + type: "string" + description: "none" + exclude-node-edge-point: + type: "string" + description: "none" + include-node-edge-point: + type: "string" + description: "none" + include-link: + type: "string" + description: "This is a loose constraint - that is it is unordered and could\ + \ be a partial list " + preferred-transport-layer: + description: "soft constraint requested by client to indicate the layer(s)\ + \ of transport connection that it prefers to carry the service. This could\ + \ be same as the service layer or one of the supported server layers" $ref: "#/definitions/tapi.common.LayerProtocolName" - exclude-node: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.NodeRef" - include-topology: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.TopologyRef" - include-path: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.path.computation.PathRef" + exclude-node: + type: "string" + description: "none" + constraint-weight: + type: "integer" + format: "int32" + description: "Zero and positive values: zero means 'strongly required to\ + \ be included', +1 means 'less strongly required to be included', etc.\r\ + \n For example the work/intended route will be calculated\ + \ considering the topologies which weights are lowest (but not negative).\r\ + \n Negative values: -1 means 'strongly required to be excluded',\ + \ -2 means 'less strongly required to be excluded', etc." + description: "The TopologyConstraint allows to specify topology entities in\ + \ order to impose specific constraints (as denoted by the attribute name)\ + \ on Connectivity/Path.\r\n The topology entities are specified\ + \ by their instance uuid rather than using references/path (to allow for mapping\ + \ to Yang 1.0).\r\n This loose typing and reference necessitates\ + \ that implementations validate not only the presence of the instance, but\ + \ also that it is of the correct type as implied by the attribute name.\r\n\ + \ If this validation fails, then the implementation is expceted\ + \ to return an error.\r\n " tapi.path.computation.computep2ppath.Input: type: "object" properties: topology-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - routing-constraint: + end-point: + type: "array" description: "none" - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + items: + $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" objective-function: description: "none" $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" - sep: + name: type: "array" - description: "none" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." items: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + $ref: "#/definitions/tapi.common.NameAndValue" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.path.computation.computep2ppath.Output: type: "object" properties: @@ -8789,9 +6546,16 @@ definitions: tapi.path.computation.deletep2ppath.Input: type: "object" properties: - path-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.path.computation.deletep2ppath.Output: type: "object" properties: @@ -8801,15 +6565,29 @@ definitions: tapi.path.computation.optimizep2ppath.Input: type: "object" properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" routing-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - path-id-or-name: - type: "string" - description: "none" optimization-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" objective-function: description: "none" $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" @@ -8905,7 +6683,7 @@ definitions: type: "string" description: "High frequency deviation from true periodicity of a signal and\ \ therefore a small high rate of change of transfer latency.\r\n \ - \ Applies to TDM systems (and not packet)." + \ Applies to TDM systems (and not packet)." fixed-latency-characteristic: type: "string" description: "A TopologicalEntity suffers delay caused by the realization\ @@ -8916,7 +6694,7 @@ definitions: type: "string" description: "Low frequency deviation from true periodicity of a signal and\ \ therefore a small low rate of change of transfer latency.\r\n \ - \ Applies to TDM systems (and not packet)." + \ Applies to TDM systems (and not packet)." queing-latency-characteristic: type: "string" description: "The specific queuing latency for the traffic property." @@ -8948,19 +6726,22 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.common.LayerProtocolName" - resilience-type: + restoration-policy: description: "none" - $ref: "#/definitions/tapi.topology.ResilienceType" + $ref: "#/definitions/tapi.topology.RestorationPolicy" node-edge-point: type: "array" description: "none" items: $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + protection-type: + description: "none" + $ref: "#/definitions/tapi.topology.ProtectionType" direction: - description: "The directionality of the Link. \r\n Is\ - \ applicable to simple Links where all LinkEnds are BIDIRECTIONAL (the\ - \ Link will be BIDIRECTIONAL) or UNIDIRECTIONAL (the Link will be UNIDIRECTIONAL).\ - \ \r\n Is not present in more complex cases." + description: "The directionality of the Link. \r\n Is applicable\ + \ to simple Links where all LinkEnds are BIDIRECTIONAL (the Link will\ + \ be BIDIRECTIONAL) or UNIDIRECTIONAL (the Link will be UNIDIRECTIONAL).\ + \ \r\n Is not present in more complex cases." $ref: "#/definitions/tapi.common.ForwardingDirection" description: "The Link object class models effective adjacency between two or\ \ more ForwardingDomains (FD). " @@ -8974,6 +6755,16 @@ definitions: description: "none" x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:link/tapi-topology:uuid" description: "none" + tapi.topology.NepLayerProtocolCapability: + type: "object" + properties: + layer-protocol-qualifier: + type: "string" + description: "none" + number-of-cep-instances: + type: "integer" + format: "int32" + description: "none" tapi.topology.NetworkTopologyService: allOf: - $ref: "#/definitions/tapi.common.GlobalClass" @@ -9003,16 +6794,16 @@ definitions: encap-topology: description: "none" $ref: "#/definitions/tapi.topology.TopologyRef" - owned-node-edge-point: + node-rule-group: type: "array" description: "none" items: - $ref: "#/definitions/tapi.topology.NodeEdgePoint" - node-rule-group: + $ref: "#/definitions/tapi.topology.NodeRuleGroup" + node-edge-point: type: "array" description: "none" items: - $ref: "#/definitions/tapi.topology.NodeRuleGroup" + $ref: "#/definitions/tapi.topology.NodeEdgePoint" aggregated-node-edge-point: type: "array" description: "none" @@ -9021,8 +6812,8 @@ definitions: description: "The ForwardingDomain (FD) object class models the ForwardingDomain\ \ topological component which is used to effect forwarding of transport characteristic\ \ information and offers the potential to enable forwarding. \r\n \ - \ At the lowest level of recursion, an FD (within a network element\ - \ (NE)) represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ + \ At the lowest level of recursion, an FD (within a network element (NE))\ + \ represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ \ multiple switch matrices (FDs). " tapi.topology.NodeEdgePoint: allOf: @@ -9044,6 +6835,11 @@ definitions: \ balancing/Resilience) should be considered experimental" items: $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + available-cep-layer-protocol: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NepLayerProtocolCapability" aggregated-node-edge-point: type: "array" description: "none" @@ -9055,14 +6851,9 @@ definitions: link-port-direction: description: "The orientation of defined flow at the LinkEnd." $ref: "#/definitions/tapi.common.PortDirection" - supported-cep-layer-protocol-qualifier: - type: "array" - description: "none" - items: - type: "string" description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ \ termination and adaptation functions of one or more transport layers. \r\ - \n The structure of LTP supports all transport protocols including\ + \n The structure of LTP supports all transport protocols including\ \ circuit and packet forms." tapi.topology.NodeEdgePointRef: allOf: @@ -9072,7 +6863,7 @@ definitions: node-edge-point-uuid: type: "string" description: "none" - x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:owned-node-edge-point/tapi-topology:uuid" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:node-edge-point/tapi-topology:uuid" description: "none" tapi.topology.NodeRef: allOf: @@ -9127,41 +6918,32 @@ definitions: tapi.topology.ProtectionType: type: "string" enum: - - "NO_PROTECTON" + - "NO_PROTECTION" - "ONE_PLUS_ONE_PROTECTION" - - "ONE_PLUS_ONE_PROTECTION_WITH_DYNAMIC_RESTORATION" - - "PERMANENT_ONE_PLUS_ONE_PROTECTION" - "ONE_FOR_ONE_PROTECTION" - - "DYNAMIC_RESTORATION" - - "PRE_COMPUTED_RESTORATION" - tapi.topology.ResilienceType: - type: "object" - properties: - restoration-policy: - description: "none" - $ref: "#/definitions/tapi.topology.RestorationPolicy" - protection-type: - description: "none" - $ref: "#/definitions/tapi.topology.ProtectionType" + - "ONE_FOR_N_PROTECTION" + - "M_FOR_N_PROTECTION" + - "ONE_FOR_ONE_BY_N" tapi.topology.RestorationPolicy: type: "string" enum: - "PER_DOMAIN_RESTORATION" - "END_TO_END_RESTORATION" - "NA" + - "DYNAMIC_RESTORATION" + - "PRE_COMPUTED_RESTORATION" tapi.topology.RiskCharacteristic: type: "object" properties: risk-characteristic-name: type: "string" description: "The name of the risk characteristic. The characteristic may\ - \ be related to a specific degree of closeness. \r\n \ - \ For example a particular characteristic may apply to failures that are\ - \ localized (e.g. to one side of a road) where as another characteristic\ - \ may relate to failures that have a broader impact (e.g. both sides of\ - \ a road that crosses a bridge).\r\n Depending upon the\ - \ importance of the traffic being routed different risk characteristics\ - \ will be evaluated." + \ be related to a specific degree of closeness. \r\n For\ + \ example a particular characteristic may apply to failures that are localized\ + \ (e.g. to one side of a road) where as another characteristic may relate\ + \ to failures that have a broader impact (e.g. both sides of a road that\ + \ crosses a bridge).\r\n Depending upon the importance of\ + \ the traffic being routed different risk characteristics will be evaluated." risk-identifier-list: type: "array" description: "A list of the identifiers of each physical/geographic unit (with\ @@ -9223,11 +7005,16 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.topology.Node" + boundary-node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" description: "The ForwardingDomain (FD) object class models the ForwardingDomain\ \ topological component which is used to effect forwarding of transport characteristic\ \ information and offers the potential to enable forwarding. \r\n \ - \ At the lowest level of recursion, an FD (within a network element\ - \ (NE)) represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ + \ At the lowest level of recursion, an FD (within a network element (NE))\ + \ represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ \ multiple switch matrices (FDs). " tapi.topology.TopologyContext: type: "object" @@ -9262,7 +7049,7 @@ definitions: error-characteristic: type: "string" description: "Describes the degree to which the signal propagated can be errored.\ - \ \r\n Applies to TDM systems as the errored signal will\ + \ \r\n Applies to TDM systems as the errored signal will\ \ be propagated and not packet as errored packets will be discarded." unavailable-time-characteristic: type: "string" @@ -9275,19 +7062,19 @@ definitions: delivery-order-characteristic: type: "string" description: "Describes the degree to which packets will be delivered out\ - \ of sequence.\r\n Does not apply to TDM as the TDM protocols\ + \ of sequence.\r\n Does not apply to TDM as the TDM protocols\ \ maintain strict order." repeat-delivery-characteristic: type: "string" description: "Primarily applies to packet systems where a packet may be delivered\ - \ more than once (in fault recovery for example). \r\n \ - \ It can also apply to TDM where several frames may be received twice\ - \ due to switching in a system with a large differential propagation delay." + \ more than once (in fault recovery for example). \r\n It\ + \ can also apply to TDM where several frames may be received twice due to\ + \ switching in a system with a large differential propagation delay." loss-characteristic: type: "string" description: "Describes the acceptable characteristic of lost packets where\ \ loss may result from discard due to errors or overflow.\r\n \ - \ Applies to packet systems and not TDM (as for TDM errored signals\ + \ Applies to packet systems and not TDM (as for TDM errored signals\ \ are propagated unless grossly errored and overflow/underflow turns into\ \ timing slips)." tapi.topology.TransferTimingPac: @@ -9324,12 +7111,27 @@ definitions: tapi.topology.getlinkdetails.Input: type: "object" properties: - link-id-or-name: - type: "string" - description: "none" - topology-id-or-name: + link-id: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.topology.getlinkdetails.Output: type: "object" properties: @@ -9339,12 +7141,27 @@ definitions: tapi.topology.getnodedetails.Input: type: "object" properties: - node-id-or-name: - type: "string" - description: "none" - topology-id-or-name: - type: "string" - description: "none" + node-id: + type: "string" + description: "UUID of the Node: An identifier that is universally unique within\ + \ an identifier space, where the identifier space is itself globally unique,\ + \ and immutable.\r\n An UUID carries no semantics with\ + \ respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC 4122. The canonical\ + \ representation uses lowercase characters.\r\n Pattern:\ + \ [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\ + \ \r\n Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.topology.getnodedetails.Output: type: "object" properties: @@ -9354,15 +7171,37 @@ definitions: tapi.topology.getnodeedgepointdetails.Input: type: "object" properties: - ep-id-or-name: - type: "string" - description: "none" - node-id-or-name: - type: "string" - description: "none" - topology-id-or-name: + node-id: + type: "string" + description: "UUID of the parent Node: An identifier that is universally unique\ + \ within an identifier space, where the identifier space is itself globally\ + \ unique, and immutable.\r\n An UUID carries no semantics\ + \ with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC 4122. The\ + \ canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\ + \ \r\n Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Node's Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + node-edge-point-id: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.topology.getnodeedgepointdetails.Output: type: "object" properties: @@ -9372,9 +7211,16 @@ definitions: tapi.topology.gettopologydetails.Input: type: "object" properties: - topology-id-or-name: + topology-id: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.topology.gettopologydetails.Output: type: "object" properties: diff --git a/OAS/tapi-photonic-media@2018-12-10.yaml b/OAS/tapi-photonic-media@2019-03-31.yaml similarity index 67% rename from OAS/tapi-photonic-media@2018-12-10.yaml rename to OAS/tapi-photonic-media@2019-03-31.yaml index 723d9bc4..8671ef7a 100644 --- a/OAS/tapi-photonic-media@2018-12-10.yaml +++ b/OAS/tapi-photonic-media@2019-03-31.yaml @@ -1,10 +1,153 @@ --- swagger: "2.0" info: - description: "tapi-oam,tapi-photonic-media,tapi-path-computation,tapi-connectivity,tapi-dsr,tapi-notification,tapi-topology,tapi-common,tapi-odu\ - \ API generated from yang definitions" - version: "1.0" - title: "tapi-oam,tapi-photonic-media,tapi-path-computation,tapi-connectivity,tapi-dsr,tapi-notification,tapi-topology,tapi-common,tapi-odu\ + description: "\r\n This module contains TAPI Odu Model definitions.\r\n \ + \ Source: TapiOdu.uml\r\n Copyright (c) 2018 Open Networking Foundation\ + \ (ONF). All rights reserved.\r\n License: This module is distributed under\ + \ the Apache License 2.0\r\n - The TAPI YANG models included in this TAPI\ + \ release are a *normative* part of the TAPI SDK.\r\n - The YANG specifications\ + \ have been generated from the corresponding UML model using the [ONF EAGLE UML2YANG\ + \ mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Notification\ + \ Model definitions.\r\n Source: TapiNotification.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Topology\ + \ Model definitions.\r\n Source: TapiTopology.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI DSR Model\ + \ definitions.\r\n Source: TapiDsr.uml\r\n Copyright (c) 2018 Open\ + \ Networking Foundation (ONF). All rights reserved.\r\n License: This module\ + \ is distributed under the Apache License 2.0\r\n - The TAPI YANG models\ + \ included in this TAPI release are a *normative* part of the TAPI SDK.\r\n \ + \ - The YANG specifications have been generated from the corresponding UML\ + \ model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Common Model\ + \ definitions.\r\n Source: TapiCommon.uml\r\n Copyright (c) 2018\ + \ Open Networking Foundation (ONF). All rights reserved.\r\n License: This\ + \ module is distributed under the Apache License 2.0\r\n - The TAPI YANG\ + \ models included in this TAPI release are a *normative* part of the TAPI SDK.\r\ + \n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Path Computation\ + \ Model definitions.\r\n Source: TapiPathComputation.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Connectivity\ + \ Model definitions.\r\n Source: TapiConnectivity.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI OAM Model\ + \ definitions.\r\n Source: TapiOam.uml\r\n Copyright (c) 2018 Open\ + \ Networking Foundation (ONF). All rights reserved.\r\n License: This module\ + \ is distributed under the Apache License 2.0\r\n - The TAPI YANG models\ + \ included in this TAPI release are a *normative* part of the TAPI SDK.\r\n \ + \ - The YANG specifications have been generated from the corresponding UML\ + \ model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI PhotonicMedia\ + \ Model definitions.\r\n Source: TapiPhotonicMedia.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases." + version: "2.2.0" + title: "tapi-odu,tapi-notification,tapi-topology,tapi-dsr,tapi-common,tapi-path-computation,tapi-connectivity,tapi-oam,tapi-photonic-media\ \ API" host: "localhost:1234" consumes: @@ -16,7 +159,8 @@ paths: get: tags: - "tapi-common" - description: "returns tapi.common.Context" + summary: "returns tapi.common.Context" + description: "none" parameters: [] responses: 200: @@ -28,7 +172,8 @@ paths: post: tags: - "tapi-common" - description: "creates tapi.common.Context" + summary: "creates tapi.common.Context" + description: "none" parameters: - in: "body" name: "tapi.common.Context.body-param" @@ -46,7 +191,8 @@ paths: put: tags: - "tapi-common" - description: "creates or updates tapi.common.Context" + summary: "creates or updates tapi.common.Context" + description: "none" parameters: - in: "body" name: "tapi.common.Context.body-param" @@ -64,7 +210,8 @@ paths: delete: tags: - "tapi-common" - description: "removes tapi.common.Context" + summary: "removes tapi.common.Context" + description: "none" parameters: [] responses: 400: @@ -75,7 +222,8 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityContext" + summary: "returns tapi.connectivity.context.ConnectivityContext" + description: "Augments the base TAPI Context with ConnectivityService information" parameters: [] responses: 200: @@ -87,7 +235,8 @@ paths: post: tags: - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityContext" + summary: "creates tapi.connectivity.context.ConnectivityContext" + description: "Augments the base TAPI Context with ConnectivityService information" parameters: - in: "body" name: "tapi.connectivity.context.ConnectivityContext.body-param" @@ -105,7 +254,8 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityContext" + summary: "creates or updates tapi.connectivity.context.ConnectivityContext" + description: "Augments the base TAPI Context with ConnectivityService information" parameters: - in: "body" name: "tapi.connectivity.context.ConnectivityContext.body-param" @@ -123,7 +273,8 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityContext" + summary: "removes tapi.connectivity.context.ConnectivityContext" + description: "Augments the base TAPI Context with ConnectivityService information" parameters: [] responses: 400: @@ -134,7 +285,8 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.Connection" + summary: "returns tapi.connectivity.Connection" + description: "none" parameters: - name: "uuid" in: "path" @@ -148,11 +300,31 @@ paths: $ref: "#/definitions/tapi.connectivity.Connection" 400: description: "Internal error" + /data/context/connectivity-context/connection={uuid}/bounding-node/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.topology.NodeRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connection" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeRef" + schema: + $ref: "#/definitions/tapi.topology.NodeRef" + 400: + description: "Internal error" ? /data/context/connectivity-context/connection={uuid}/connection-end-point={topology-uuid},{node-uuid},{node-edge-point-uuid},{connection-end-point-uuid}/ : get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionEndPointRef" + summary: "returns tapi.connectivity.ConnectionEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -190,7 +362,14 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionRef" + summary: "returns tapi.connectivity.ConnectionRef" + description: "An Connection object supports a recursive aggregation relationship\ + \ such that the internal construction of an Connection can be exposed as multiple\ + \ lower level Connection objects (partitioning).\r\n Aggregation\ + \ is used as for the Node/Topology to allow changes in hierarchy. \r\n \ + \ Connection aggregation reflects Node/Topology aggregation.\ + \ \r\n The FC represents a Cross-Connection in an NE. The Cross-Connection\ + \ in an NE is not necessarily the lowest level of FC partitioning." parameters: - name: "uuid" in: "path" @@ -213,7 +392,10 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -236,7 +418,8 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.Route" + summary: "returns tapi.connectivity.Route" + description: "none" parameters: - name: "uuid" in: "path" @@ -259,7 +442,8 @@ paths: : get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionEndPointRef" + summary: "returns tapi.connectivity.ConnectionEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -302,7 +486,10 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -330,7 +517,8 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.topology.LinkRef" + summary: "returns tapi.topology.LinkRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -358,7 +546,8 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.SwitchControl" + summary: "returns tapi.connectivity.SwitchControl" + description: "none" parameters: - name: "uuid" in: "path" @@ -381,7 +570,10 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -405,34 +597,12 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/resilience-type/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.ResilienceType" - parameters: - - name: "uuid" - in: "path" - description: "Id of connection" - required: true - type: "string" - - name: "switch-control-uuid" - in: "path" - description: "Id of switch-control" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.ResilienceType" - schema: - $ref: "#/definitions/tapi.topology.ResilienceType" - 400: - description: "Internal error" ? /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/sub-switch-control={connection-uuid},{sub-switch-control-switch-control-uuid}/ : get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.SwitchControlRef" + summary: "returns tapi.connectivity.SwitchControlRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -465,7 +635,8 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.Switch" + summary: "returns tapi.connectivity.Switch" + description: "none" parameters: - name: "uuid" in: "path" @@ -493,7 +664,10 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -526,7 +700,8 @@ paths: : get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionEndPointRef" + summary: "returns tapi.connectivity.ConnectionEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -574,7 +749,8 @@ paths: : get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.RouteRef" + summary: "returns tapi.connectivity.RouteRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -612,7 +788,8 @@ paths: post: tags: - "tapi-connectivity" - description: "creates tapi.connectivity.connectivitycontext.ConnectivityService" + summary: "creates tapi.connectivity.connectivitycontext.ConnectivityService" + description: "none" parameters: - in: "body" name: "tapi.connectivity.connectivitycontext.ConnectivityService.body-param" @@ -632,7 +809,8 @@ paths: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.connectivitycontext.ConnectivityService" + summary: "returns tapi.connectivity.connectivitycontext.ConnectivityService" + description: "none" parameters: - name: "uuid" in: "path" @@ -646,34 +824,11 @@ paths: $ref: "#/definitions/tapi.connectivity.connectivitycontext.ConnectivityService" 400: description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.connectivitycontext.ConnectivityService" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.connectivity.connectivitycontext.ConnectivityService.body-param" - description: "tapi.connectivity.connectivitycontext.ConnectivityService to\ - \ be added to list" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.connectivitycontext.ConnectivityService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-connectivity" - description: "creates or updates tapi.connectivity.connectivitycontext.ConnectivityService" + summary: "creates or updates tapi.connectivity.connectivitycontext.ConnectivityService" + description: "none" parameters: - name: "uuid" in: "path" @@ -697,7 +852,8 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.connectivity.connectivitycontext.ConnectivityService" + summary: "removes tapi.connectivity.connectivitycontext.ConnectivityService" + description: "none" parameters: - name: "uuid" in: "path" @@ -709,34 +865,12 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/avoid-topology={topology-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of avoid-topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" /data/context/connectivity-context/connectivity-service={uuid}/connection={connection-uuid}/: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionRef" + summary: "returns tapi.connectivity.ConnectionRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -755,11 +889,12 @@ paths: $ref: "#/definitions/tapi.connectivity.ConnectionRef" 400: description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/coroute-inclusion/: + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/: get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityServiceRef" + summary: "returns tapi.connectivity.ConnectivityConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -768,15 +903,16 @@ paths: type: "string" responses: 200: - description: "tapi.connectivity.ConnectivityServiceRef" + description: "tapi.connectivity.ConnectivityConstraint" schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" 400: description: "Internal error" post: tags: - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceRef" + summary: "creates tapi.connectivity.ConnectivityConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -784,11 +920,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.connectivity.ConnectivityServiceRef.body-param" - description: "tapi.connectivity.ConnectivityServiceRef to be added to list" + name: "tapi.connectivity.ConnectivityConstraint.body-param" + description: "tapi.connectivity.ConnectivityConstraint to be added to list" required: false schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" responses: 201: description: "Object created" @@ -799,7 +935,8 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityServiceRef" + summary: "creates or updates tapi.connectivity.ConnectivityConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -807,11 +944,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.connectivity.ConnectivityServiceRef.body-param" - description: "tapi.connectivity.ConnectivityServiceRef to be added or updated" + name: "tapi.connectivity.ConnectivityConstraint.body-param" + description: "tapi.connectivity.ConnectivityConstraint to be added or updated" required: false schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" responses: 201: description: "Object created" @@ -822,7 +959,8 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityServiceRef" + summary: "removes tapi.connectivity.ConnectivityConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -834,74 +972,42 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/cost-characteristic/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/cost-characteristic={cost-name}/: + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/coroute-inclusion/: get: tags: - "tapi-connectivity" - description: "returns tapi.topology.CostCharacteristic" + summary: "returns tapi.connectivity.ConnectivityServiceRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" responses: 200: - description: "tapi.topology.CostCharacteristic" + description: "tapi.connectivity.ConnectivityServiceRef" schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" 400: description: "Internal error" post: tags: - "tapi-connectivity" - description: "creates tapi.topology.CostCharacteristic" + summary: "creates tapi.connectivity.ConnectivityServiceRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" + name: "tapi.connectivity.ConnectivityServiceRef.body-param" + description: "tapi.connectivity.ConnectivityServiceRef to be added to list" required: false schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" responses: 201: description: "Object created" @@ -912,24 +1018,20 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.topology.CostCharacteristic" + summary: "creates or updates tapi.connectivity.ConnectivityServiceRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added or updated" + name: "tapi.connectivity.ConnectivityServiceRef.body-param" + description: "tapi.connectivity.ConnectivityServiceRef to be added or updated" required: false schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" responses: 201: description: "Object created" @@ -940,28 +1042,25 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.topology.CostCharacteristic" + summary: "removes tapi.connectivity.ConnectivityServiceRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/diversity-exclusion/: + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/diversity-exclusion/: post: tags: - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceRef" + summary: "creates tapi.connectivity.ConnectivityServiceRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -981,11 +1080,12 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/diversity-exclusion={connectivity-service-uuid}/: - get: + ? /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/diversity-exclusion={connectivity-service-uuid}/ + : get: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityServiceRef" + summary: "returns tapi.connectivity.ConnectivityServiceRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1004,10 +1104,11 @@ paths: $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" 400: description: "Internal error" - post: + put: tags: - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceRef" + summary: "creates or updates tapi.connectivity.ConnectivityServiceRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1021,7 +1122,7 @@ paths: type: "string" - in: "body" name: "tapi.connectivity.ConnectivityServiceRef.body-param" - description: "tapi.connectivity.ConnectivityServiceRef to be added to list" + description: "tapi.connectivity.ConnectivityServiceRef to be added or updated" required: false schema: $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" @@ -1030,12 +1131,13 @@ paths: description: "Object created" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + 204: + description: "Object modified" + delete: tags: - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityServiceRef" + summary: "removes tapi.connectivity.ConnectivityServiceRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1047,44 +1149,35 @@ paths: description: "Id of diversity-exclusion" required: true type: "string" - - in: "body" - name: "tapi.connectivity.ConnectivityServiceRef.body-param" - description: "tapi.connectivity.ConnectivityServiceRef to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" responses: - 201: - description: "Object created" 400: description: "Internal error" 204: - description: "Object modified" - delete: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/requested-capacity/: + get: tags: - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityServiceRef" + summary: "returns tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "connectivity-service-uuid" - in: "path" - description: "Id of diversity-exclusion" - required: true - type: "string" responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point/: post: tags: - "tapi-connectivity" - description: "creates tapi.connectivity.connectivityservice.EndPoint" + summary: "creates tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" @@ -1092,12 +1185,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.connectivity.connectivityservice.EndPoint.body-param" - description: "tapi.connectivity.connectivityservice.EndPoint to be added to\ - \ list" + name: "tapi.common.Capacity.body-param" + description: "tapi.common.Capacity to be added to list" required: false schema: - $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" + $ref: "#/definitions/tapi.common.Capacity" responses: 201: description: "Object created" @@ -1105,51 +1197,84 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/: - get: + put: tags: - "tapi-connectivity" - description: "returns tapi.connectivity.connectivityservice.EndPoint" + summary: "creates or updates tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" + - in: "body" + name: "tapi.common.Capacity.body-param" + description: "tapi.common.Capacity to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.Capacity" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.common.Capacity" + description: "none" + parameters: + - name: "uuid" in: "path" - description: "Id of end-point" + description: "Id of connectivity-service" required: true type: "string" responses: - 200: - description: "tapi.connectivity.connectivityservice.EndPoint" - schema: - $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" 400: description: "Internal error" - post: + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/requested-capacity/total-size/: + get: tags: - "tapi-connectivity" - description: "creates tapi.connectivity.connectivityservice.EndPoint" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" in: "path" - description: "Id of end-point" + description: "Id of connectivity-service" required: true type: "string" - in: "body" - name: "tapi.connectivity.connectivityservice.EndPoint.body-param" - description: "tapi.connectivity.connectivityservice.EndPoint to be added to\ - \ list" + name: "tapi.common.CapacityValue.body-param" + description: "tapi.common.CapacityValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" + $ref: "#/definitions/tapi.common.CapacityValue" responses: 201: description: "Object created" @@ -1160,25 +1285,21 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.connectivity.connectivityservice.EndPoint" + summary: "creates or updates tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - in: "body" - name: "tapi.connectivity.connectivityservice.EndPoint.body-param" - description: "tapi.connectivity.connectivityservice.EndPoint to be added or\ - \ updated" + name: "tapi.common.CapacityValue.body-param" + description: "tapi.common.CapacityValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" + $ref: "#/definitions/tapi.common.CapacityValue" responses: 201: description: "Object created" @@ -1189,67 +1310,56 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.connectivity.connectivityservice.EndPoint" + summary: "removes tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/: + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/schedule/: get: tags: - "tapi-connectivity" - description: "returns tapi.common.Capacity" + summary: "returns tapi.common.TimeRange" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" responses: 200: - description: "tapi.common.Capacity" + description: "tapi.common.TimeRange" schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.common.TimeRange" 400: description: "Internal error" post: tags: - "tapi-connectivity" - description: "creates tapi.common.Capacity" + summary: "creates tapi.common.TimeRange" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - in: "body" - name: "tapi.common.Capacity.body-param" - description: "tapi.common.Capacity to be added to list" + name: "tapi.common.TimeRange.body-param" + description: "tapi.common.TimeRange to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.common.TimeRange" responses: 201: description: "Object created" @@ -1260,24 +1370,20 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.Capacity" + summary: "creates or updates tapi.common.TimeRange" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - in: "body" - name: "tapi.common.Capacity.body-param" - description: "tapi.common.Capacity to be added or updated" + name: "tapi.common.TimeRange.body-param" + description: "tapi.common.TimeRange to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.common.TimeRange" responses: 201: description: "Object created" @@ -1288,50 +1394,51 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.Capacity" + summary: "removes tapi.common.TimeRange" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/: - get: + /data/context/connectivity-context/connectivity-service={uuid}/end-point/: + post: tags: - "tapi-connectivity" - description: "returns tapi.common.BandwidthProfile" + summary: "creates tapi.connectivity.connectivityservice.EndPoint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" + - in: "body" + name: "tapi.connectivity.connectivityservice.EndPoint.body-param" + description: "tapi.connectivity.connectivityservice.EndPoint to be added to\ + \ list" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/: + get: tags: - "tapi-connectivity" - description: "creates tapi.common.BandwidthProfile" + summary: "returns tapi.connectivity.connectivityservice.EndPoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -1343,23 +1450,18 @@ paths: description: "Id of end-point" required: true type: "string" - - in: "body" - name: "tapi.common.BandwidthProfile.body-param" - description: "tapi.common.BandwidthProfile to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" responses: - 201: - description: "Object created" + 200: + description: "tapi.connectivity.connectivityservice.EndPoint" + schema: + $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.BandwidthProfile" + summary: "creates or updates tapi.connectivity.connectivityservice.EndPoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -1372,11 +1474,12 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.BandwidthProfile.body-param" - description: "tapi.common.BandwidthProfile to be added or updated" + name: "tapi.connectivity.connectivityservice.EndPoint.body-param" + description: "tapi.connectivity.connectivityservice.EndPoint to be added or\ + \ updated" required: false schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" responses: 201: description: "Object created" @@ -1387,7 +1490,8 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.BandwidthProfile" + summary: "removes tapi.connectivity.connectivityservice.EndPoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -1404,11 +1508,12 @@ paths: description: "Internal error" 204: description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-burst-size/ - : get: + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/: + get: tags: - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" @@ -1422,15 +1527,16 @@ paths: type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" post: tags: - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + summary: "creates tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" @@ -1443,11 +1549,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.common.Capacity.body-param" + description: "tapi.common.Capacity to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" responses: 201: description: "Object created" @@ -1458,7 +1564,8 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" @@ -1471,11 +1578,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.common.Capacity.body-param" + description: "tapi.common.Capacity to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" responses: 201: description: "Object created" @@ -1486,7 +1593,8 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" @@ -1503,11 +1611,13 @@ paths: description: "Internal error" 204: description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-information-rate/ - : get: + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/total-size/: + get: tags: - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -1529,7 +1639,9 @@ paths: post: tags: - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + summary: "creates tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -1557,7 +1669,9 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -1585,7 +1699,9 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -1602,11 +1718,12 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-burst-size/: - get: + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/connection-end-point={topology-uuid},{node-uuid},{node-edge-point-uuid},{connection-end-point-uuid}/ + : get: tags: - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.connectivity.ConnectionEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -1618,17 +1735,62 @@ paths: description: "Id of end-point" required: true type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.connectivity.ConnectionEndPointRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.connectivity.ConnectionEndPointRef" + 400: + description: "Internal error" + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/media-channel-connectivity-service-end-point-spec/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.MediaChannelConnectivityServiceEndPointSpec" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.MediaChannelConnectivityServiceEndPointSpec" + schema: + $ref: "#/definitions/tapi.photonic.media.MediaChannelConnectivityServiceEndPointSpec" 400: description: "Internal error" post: tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + - "tapi-photonic-media" + summary: "creates tapi.photonic.media.MediaChannelConnectivityServiceEndPointSpec" + description: "none" parameters: - name: "uuid" in: "path" @@ -1641,11 +1803,12 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.photonic.media.MediaChannelConnectivityServiceEndPointSpec.body-param" + description: "tapi.photonic.media.MediaChannelConnectivityServiceEndPointSpec\ + \ to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.photonic.media.MediaChannelConnectivityServiceEndPointSpec" responses: 201: description: "Object created" @@ -1655,8 +1818,9 @@ paths: description: "Object already exists" put: tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + - "tapi-photonic-media" + summary: "creates or updates tapi.photonic.media.MediaChannelConnectivityServiceEndPointSpec" + description: "none" parameters: - name: "uuid" in: "path" @@ -1669,11 +1833,12 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.photonic.media.MediaChannelConnectivityServiceEndPointSpec.body-param" + description: "tapi.photonic.media.MediaChannelConnectivityServiceEndPointSpec\ + \ to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.photonic.media.MediaChannelConnectivityServiceEndPointSpec" responses: 201: description: "Object created" @@ -1683,8 +1848,9 @@ paths: description: "Object modified" delete: tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + - "tapi-photonic-media" + summary: "removes tapi.photonic.media.MediaChannelConnectivityServiceEndPointSpec" + description: "none" parameters: - name: "uuid" in: "path" @@ -1701,11 +1867,12 @@ paths: description: "Internal error" 204: description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-information-rate/ + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/media-channel-connectivity-service-end-point-spec/mc-config/ : get: tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.MediaChannelConfigPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -1719,15 +1886,16 @@ paths: type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.photonic.media.MediaChannelConfigPac" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.photonic.media.MediaChannelConfigPac" 400: description: "Internal error" post: tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + - "tapi-photonic-media" + summary: "creates tapi.photonic.media.MediaChannelConfigPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -1740,11 +1908,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.photonic.media.MediaChannelConfigPac.body-param" + description: "tapi.photonic.media.MediaChannelConfigPac to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.photonic.media.MediaChannelConfigPac" responses: 201: description: "Object created" @@ -1754,8 +1922,9 @@ paths: description: "Object already exists" put: tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + - "tapi-photonic-media" + summary: "creates or updates tapi.photonic.media.MediaChannelConfigPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -1768,11 +1937,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.photonic.media.MediaChannelConfigPac.body-param" + description: "tapi.photonic.media.MediaChannelConfigPac to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.photonic.media.MediaChannelConfigPac" responses: 201: description: "Object created" @@ -1782,8 +1951,9 @@ paths: description: "Object modified" delete: tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + - "tapi-photonic-media" + summary: "removes tapi.photonic.media.MediaChannelConfigPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -1800,11 +1970,12 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/total-size/: - get: + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/media-channel-connectivity-service-end-point-spec/mc-config/spectrum/ + : get: tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.SpectrumBand" + description: "none" parameters: - name: "uuid" in: "path" @@ -1818,15 +1989,16 @@ paths: type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.photonic.media.SpectrumBand" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.photonic.media.SpectrumBand" 400: description: "Internal error" post: tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + - "tapi-photonic-media" + summary: "creates tapi.photonic.media.SpectrumBand" + description: "none" parameters: - name: "uuid" in: "path" @@ -1839,11 +2011,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.photonic.media.SpectrumBand.body-param" + description: "tapi.photonic.media.SpectrumBand to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.photonic.media.SpectrumBand" responses: 201: description: "Object created" @@ -1853,8 +2025,9 @@ paths: description: "Object already exists" put: tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + - "tapi-photonic-media" + summary: "creates or updates tapi.photonic.media.SpectrumBand" + description: "none" parameters: - name: "uuid" in: "path" @@ -1867,11 +2040,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" - required: false + name: "tapi.photonic.media.SpectrumBand.body-param" + description: "tapi.photonic.media.SpectrumBand to be added or updated" + required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.photonic.media.SpectrumBand" responses: 201: description: "Object created" @@ -1881,8 +2054,9 @@ paths: description: "Object modified" delete: tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + - "tapi-photonic-media" + summary: "removes tapi.photonic.media.SpectrumBand" + description: "none" parameters: - name: "uuid" in: "path" @@ -1899,54 +2073,12 @@ paths: description: "Internal error" 204: description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/connection-end-point={topology-uuid},{node-uuid},{node-edge-point-uuid},{connection-end-point-uuid}/ + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/media-channel-connectivity-service-end-point-spec/mc-config/spectrum/frequency-constraint/ : get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.connectivity.ConnectionEndPointRef" - schema: - $ref: "#/definitions/tapi.connectivity.ConnectionEndPointRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/media-channel-service-interface-point-spec/: - get: tags: - "tapi-photonic-media" - description: "returns tapi.photonic.media.MediaChannelServiceInterfacePointSpec" + summary: "returns tapi.photonic.media.FrequencyConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -1960,15 +2092,16 @@ paths: type: "string" responses: 200: - description: "tapi.photonic.media.MediaChannelServiceInterfacePointSpec" + description: "tapi.photonic.media.FrequencyConstraint" schema: - $ref: "#/definitions/tapi.photonic.media.MediaChannelServiceInterfacePointSpec" + $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" 400: description: "Internal error" post: tags: - "tapi-photonic-media" - description: "creates tapi.photonic.media.MediaChannelServiceInterfacePointSpec" + summary: "creates tapi.photonic.media.FrequencyConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -1981,12 +2114,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.photonic.media.MediaChannelServiceInterfacePointSpec.body-param" - description: "tapi.photonic.media.MediaChannelServiceInterfacePointSpec to\ - \ be added to list" + name: "tapi.photonic.media.FrequencyConstraint.body-param" + description: "tapi.photonic.media.FrequencyConstraint to be added to list" required: false schema: - $ref: "#/definitions/tapi.photonic.media.MediaChannelServiceInterfacePointSpec" + $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" responses: 201: description: "Object created" @@ -1997,7 +2129,8 @@ paths: put: tags: - "tapi-photonic-media" - description: "creates or updates tapi.photonic.media.MediaChannelServiceInterfacePointSpec" + summary: "creates or updates tapi.photonic.media.FrequencyConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -2010,12 +2143,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.photonic.media.MediaChannelServiceInterfacePointSpec.body-param" - description: "tapi.photonic.media.MediaChannelServiceInterfacePointSpec to\ - \ be added or updated" + name: "tapi.photonic.media.FrequencyConstraint.body-param" + description: "tapi.photonic.media.FrequencyConstraint to be added or updated" required: false schema: - $ref: "#/definitions/tapi.photonic.media.MediaChannelServiceInterfacePointSpec" + $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" responses: 201: description: "Object created" @@ -2026,7 +2158,8 @@ paths: delete: tags: - "tapi-photonic-media" - description: "removes tapi.photonic.media.MediaChannelServiceInterfacePointSpec" + summary: "removes tapi.photonic.media.FrequencyConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -2043,11 +2176,16 @@ paths: description: "Internal error" 204: description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/media-channel-service-interface-point-spec/mc-pool/ + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/media-channel-connectivity-service-end-point-spec/power-management-config/ : get: tags: - "tapi-photonic-media" - description: "returns tapi.photonic.media.MediaChannelPoolCapabilityPac" + summary: "returns tapi.photonic.media.PowerManagementConfigPac" + description: "This parameters shall be used to configure the expected\r\n \ + \ and intended (desired) power levels at the endpoints of the\ + \ media\r\n Channel connectivity service. These parameters\ + \ are dependent of the\r\n related OTSi power-management capabilities\ + \ exposed at the SIPs" parameters: - name: "uuid" in: "path" @@ -2061,16 +2199,20 @@ paths: type: "string" responses: 200: - description: "tapi.photonic.media.MediaChannelPoolCapabilityPac" + description: "tapi.photonic.media.PowerManagementConfigPac" schema: - $ref: "#/definitions/tapi.photonic.media.MediaChannelPoolCapabilityPac" + $ref: "#/definitions/tapi.photonic.media.PowerManagementConfigPac" 400: description: "Internal error" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/media-channel-service-interface-point-spec/mc-pool/available-spectrum={upper-frequency},{lower-frequency}/ - : get: + post: tags: - "tapi-photonic-media" - description: "returns tapi.photonic.media.SpectrumBand" + summary: "creates tapi.photonic.media.PowerManagementConfigPac" + description: "This parameters shall be used to configure the expected\r\n \ + \ and intended (desired) power levels at the endpoints of the\ + \ media\r\n Channel connectivity service. These parameters\ + \ are dependent of the\r\n related OTSi power-management capabilities\ + \ exposed at the SIPs" parameters: - name: "uuid" in: "path" @@ -2082,30 +2224,29 @@ paths: description: "Id of end-point" required: true type: "string" - - name: "upper-frequency" - in: "path" - description: "Id of available-spectrum" - required: true - type: "integer" - format: "int32" - - name: "lower-frequency" - in: "path" - description: "Id of available-spectrum" - required: true - type: "integer" - format: "int32" + - in: "body" + name: "tapi.photonic.media.PowerManagementConfigPac.body-param" + description: "tapi.photonic.media.PowerManagementConfigPac to be added to\ + \ list" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.PowerManagementConfigPac" responses: - 200: - description: "tapi.photonic.media.SpectrumBand" - schema: - $ref: "#/definitions/tapi.photonic.media.SpectrumBand" + 201: + description: "Object created" 400: description: "Internal error" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/media-channel-service-interface-point-spec/mc-pool/available-spectrum={upper-frequency},{lower-frequency}/frequency-constraint/ - : get: + 409: + description: "Object already exists" + put: tags: - "tapi-photonic-media" - description: "returns tapi.photonic.media.FrequencyConstraint" + summary: "creates or updates tapi.photonic.media.PowerManagementConfigPac" + description: "This parameters shall be used to configure the expected\r\n \ + \ and intended (desired) power levels at the endpoints of the\ + \ media\r\n Channel connectivity service. These parameters\ + \ are dependent of the\r\n related OTSi power-management capabilities\ + \ exposed at the SIPs" parameters: - name: "uuid" in: "path" @@ -2117,30 +2258,29 @@ paths: description: "Id of end-point" required: true type: "string" - - name: "upper-frequency" - in: "path" - description: "Id of available-spectrum" - required: true - type: "integer" - format: "int32" - - name: "lower-frequency" - in: "path" - description: "Id of available-spectrum" - required: true - type: "integer" - format: "int32" + - in: "body" + name: "tapi.photonic.media.PowerManagementConfigPac.body-param" + description: "tapi.photonic.media.PowerManagementConfigPac to be added or\ + \ updated" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.PowerManagementConfigPac" responses: - 200: - description: "tapi.photonic.media.FrequencyConstraint" - schema: - $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" + 201: + description: "Object created" 400: description: "Internal error" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/media-channel-service-interface-point-spec/mc-pool/occupied-spectrum={upper-frequency},{lower-frequency}/ - : get: + 204: + description: "Object modified" + delete: tags: - "tapi-photonic-media" - description: "returns tapi.photonic.media.SpectrumBand" + summary: "removes tapi.photonic.media.PowerManagementConfigPac" + description: "This parameters shall be used to configure the expected\r\n \ + \ and intended (desired) power levels at the endpoints of the\ + \ media\r\n Channel connectivity service. These parameters\ + \ are dependent of the\r\n related OTSi power-management capabilities\ + \ exposed at the SIPs" parameters: - name: "uuid" in: "path" @@ -2152,30 +2292,19 @@ paths: description: "Id of end-point" required: true type: "string" - - name: "upper-frequency" - in: "path" - description: "Id of occupied-spectrum" - required: true - type: "integer" - format: "int32" - - name: "lower-frequency" - in: "path" - description: "Id of occupied-spectrum" - required: true - type: "integer" - format: "int32" responses: - 200: - description: "tapi.photonic.media.SpectrumBand" - schema: - $ref: "#/definitions/tapi.photonic.media.SpectrumBand" 400: description: "Internal error" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/media-channel-service-interface-point-spec/mc-pool/occupied-spectrum={upper-frequency},{lower-frequency}/frequency-constraint/ + 204: + description: "Object deleted" + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/media-channel-connectivity-service-end-point-spec/power-management-config/expected-maximum-input-power/ : get: tags: - "tapi-photonic-media" - description: "returns tapi.photonic.media.FrequencyConstraint" + summary: "returns tapi.photonic.media.PowerProperties" + description: "This parameter shall be used to specify the maximum input power\r\ + \n being received at the Logical-Termination-Point (LTP) associated\ + \ to the CSEP." parameters: - name: "uuid" in: "path" @@ -2187,30 +2316,20 @@ paths: description: "Id of end-point" required: true type: "string" - - name: "upper-frequency" - in: "path" - description: "Id of occupied-spectrum" - required: true - type: "integer" - format: "int32" - - name: "lower-frequency" - in: "path" - description: "Id of occupied-spectrum" - required: true - type: "integer" - format: "int32" responses: 200: - description: "tapi.photonic.media.FrequencyConstraint" + description: "tapi.photonic.media.PowerProperties" schema: - $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" + $ref: "#/definitions/tapi.photonic.media.PowerProperties" 400: description: "Internal error" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/media-channel-service-interface-point-spec/mc-pool/supportable-spectrum={upper-frequency},{lower-frequency}/ - : get: + post: tags: - "tapi-photonic-media" - description: "returns tapi.photonic.media.SpectrumBand" + summary: "creates tapi.photonic.media.PowerProperties" + description: "This parameter shall be used to specify the maximum input power\r\ + \n being received at the Logical-Termination-Point (LTP) associated\ + \ to the CSEP." parameters: - name: "uuid" in: "path" @@ -2222,30 +2341,26 @@ paths: description: "Id of end-point" required: true type: "string" - - name: "upper-frequency" - in: "path" - description: "Id of supportable-spectrum" - required: true - type: "integer" - format: "int32" - - name: "lower-frequency" - in: "path" - description: "Id of supportable-spectrum" - required: true - type: "integer" - format: "int32" + - in: "body" + name: "tapi.photonic.media.PowerProperties.body-param" + description: "tapi.photonic.media.PowerProperties to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" responses: - 200: - description: "tapi.photonic.media.SpectrumBand" - schema: - $ref: "#/definitions/tapi.photonic.media.SpectrumBand" + 201: + description: "Object created" 400: description: "Internal error" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/media-channel-service-interface-point-spec/mc-pool/supportable-spectrum={upper-frequency},{lower-frequency}/frequency-constraint/ - : get: + 409: + description: "Object already exists" + put: tags: - "tapi-photonic-media" - description: "returns tapi.photonic.media.FrequencyConstraint" + summary: "creates or updates tapi.photonic.media.PowerProperties" + description: "This parameter shall be used to specify the maximum input power\r\ + \n being received at the Logical-Termination-Point (LTP) associated\ + \ to the CSEP." parameters: - name: "uuid" in: "path" @@ -2257,30 +2372,26 @@ paths: description: "Id of end-point" required: true type: "string" - - name: "upper-frequency" - in: "path" - description: "Id of supportable-spectrum" - required: true - type: "integer" - format: "int32" - - name: "lower-frequency" - in: "path" - description: "Id of supportable-spectrum" - required: true - type: "integer" - format: "int32" + - in: "body" + name: "tapi.photonic.media.PowerProperties.body-param" + description: "tapi.photonic.media.PowerProperties to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" responses: - 200: - description: "tapi.photonic.media.FrequencyConstraint" - schema: - $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/name/: - post: + 204: + description: "Object modified" + delete: tags: - - "tapi-connectivity" - description: "creates tapi.common.NameAndValue" + - "tapi-photonic-media" + summary: "removes tapi.photonic.media.PowerProperties" + description: "This parameter shall be used to specify the maximum input power\r\ + \n being received at the Logical-Termination-Point (LTP) associated\ + \ to the CSEP." parameters: - name: "uuid" in: "path" @@ -2292,24 +2403,19 @@ paths: description: "Id of end-point" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" responses: - 201: - description: "Object created" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/name={value-name}/: - get: + 204: + description: "Object deleted" + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/media-channel-connectivity-service-end-point-spec/power-management-config/expected-minimum-input-power/ + : get: tags: - - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.PowerProperties" + description: "This parameter shall be used to specify the minimum input power\r\ + \n being received at the Logical-Termination-Point (LTP) associated\ + \ to the CSEP." parameters: - name: "uuid" in: "path" @@ -2321,22 +2427,20 @@ paths: description: "Id of end-point" required: true type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.photonic.media.PowerProperties" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.photonic.media.PowerProperties" 400: description: "Internal error" post: tags: - - "tapi-connectivity" - description: "creates tapi.common.NameAndValue" + - "tapi-photonic-media" + summary: "creates tapi.photonic.media.PowerProperties" + description: "This parameter shall be used to specify the minimum input power\r\ + \n being received at the Logical-Termination-Point (LTP) associated\ + \ to the CSEP." parameters: - name: "uuid" in: "path" @@ -2348,17 +2452,12 @@ paths: description: "Id of end-point" required: true type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.photonic.media.PowerProperties.body-param" + description: "tapi.photonic.media.PowerProperties to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.photonic.media.PowerProperties" responses: 201: description: "Object created" @@ -2368,8 +2467,11 @@ paths: description: "Object already exists" put: tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.NameAndValue" + - "tapi-photonic-media" + summary: "creates or updates tapi.photonic.media.PowerProperties" + description: "This parameter shall be used to specify the minimum input power\r\ + \n being received at the Logical-Termination-Point (LTP) associated\ + \ to the CSEP." parameters: - name: "uuid" in: "path" @@ -2381,17 +2483,12 @@ paths: description: "Id of end-point" required: true type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" + name: "tapi.photonic.media.PowerProperties.body-param" + description: "tapi.photonic.media.PowerProperties to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.photonic.media.PowerProperties" responses: 201: description: "Object created" @@ -2401,8 +2498,11 @@ paths: description: "Object modified" delete: tags: - - "tapi-connectivity" - description: "removes tapi.common.NameAndValue" + - "tapi-photonic-media" + summary: "removes tapi.photonic.media.PowerProperties" + description: "This parameter shall be used to specify the minimum input power\r\ + \n being received at the Logical-Termination-Point (LTP) associated\ + \ to the CSEP." parameters: - name: "uuid" in: "path" @@ -2414,21 +2514,19 @@ paths: description: "Id of end-point" required: true type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/otsi-connectivity-service-end-point-spec/: - get: + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/media-channel-connectivity-service-end-point-spec/power-management-config/intended-maximum-output-power/ + : get: tags: - "tapi-photonic-media" - description: "returns tapi.photonic.media.OtsiConnectivityServiceEndPointSpec" + summary: "returns tapi.photonic.media.PowerProperties" + description: "This parameter shall be used to specify the maximum output power\r\ + \n desired at the Logical-Termination-Point (LTP) associated\ + \ to the CSEP." parameters: - name: "uuid" in: "path" @@ -2442,15 +2540,18 @@ paths: type: "string" responses: 200: - description: "tapi.photonic.media.OtsiConnectivityServiceEndPointSpec" + description: "tapi.photonic.media.PowerProperties" schema: - $ref: "#/definitions/tapi.photonic.media.OtsiConnectivityServiceEndPointSpec" + $ref: "#/definitions/tapi.photonic.media.PowerProperties" 400: description: "Internal error" post: tags: - "tapi-photonic-media" - description: "creates tapi.photonic.media.OtsiConnectivityServiceEndPointSpec" + summary: "creates tapi.photonic.media.PowerProperties" + description: "This parameter shall be used to specify the maximum output power\r\ + \n desired at the Logical-Termination-Point (LTP) associated\ + \ to the CSEP." parameters: - name: "uuid" in: "path" @@ -2463,12 +2564,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.photonic.media.OtsiConnectivityServiceEndPointSpec.body-param" - description: "tapi.photonic.media.OtsiConnectivityServiceEndPointSpec to be\ - \ added to list" + name: "tapi.photonic.media.PowerProperties.body-param" + description: "tapi.photonic.media.PowerProperties to be added to list" required: false schema: - $ref: "#/definitions/tapi.photonic.media.OtsiConnectivityServiceEndPointSpec" + $ref: "#/definitions/tapi.photonic.media.PowerProperties" responses: 201: description: "Object created" @@ -2479,7 +2579,10 @@ paths: put: tags: - "tapi-photonic-media" - description: "creates or updates tapi.photonic.media.OtsiConnectivityServiceEndPointSpec" + summary: "creates or updates tapi.photonic.media.PowerProperties" + description: "This parameter shall be used to specify the maximum output power\r\ + \n desired at the Logical-Termination-Point (LTP) associated\ + \ to the CSEP." parameters: - name: "uuid" in: "path" @@ -2492,12 +2595,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.photonic.media.OtsiConnectivityServiceEndPointSpec.body-param" - description: "tapi.photonic.media.OtsiConnectivityServiceEndPointSpec to be\ - \ added or updated" + name: "tapi.photonic.media.PowerProperties.body-param" + description: "tapi.photonic.media.PowerProperties to be added or updated" required: false schema: - $ref: "#/definitions/tapi.photonic.media.OtsiConnectivityServiceEndPointSpec" + $ref: "#/definitions/tapi.photonic.media.PowerProperties" responses: 201: description: "Object created" @@ -2508,7 +2610,10 @@ paths: delete: tags: - "tapi-photonic-media" - description: "removes tapi.photonic.media.OtsiConnectivityServiceEndPointSpec" + summary: "removes tapi.photonic.media.PowerProperties" + description: "This parameter shall be used to specify the maximum output power\r\ + \n desired at the Logical-Termination-Point (LTP) associated\ + \ to the CSEP." parameters: - name: "uuid" in: "path" @@ -2525,11 +2630,14 @@ paths: description: "Internal error" 204: description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/otsi-connectivity-service-end-point-spec/otsi-config/ + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/media-channel-connectivity-service-end-point-spec/power-management-config/intended-minimum-output-power/ : get: tags: - "tapi-photonic-media" - description: "returns tapi.photonic.media.OtsiTerminationConfigPac" + summary: "returns tapi.photonic.media.PowerProperties" + description: "This parameter shall be used to specify the minimum output power\r\ + \n desired at the Logical-Termination-Point (LTP) associated\ + \ to the CSEP." parameters: - name: "uuid" in: "path" @@ -2543,15 +2651,18 @@ paths: type: "string" responses: 200: - description: "tapi.photonic.media.OtsiTerminationConfigPac" + description: "tapi.photonic.media.PowerProperties" schema: - $ref: "#/definitions/tapi.photonic.media.OtsiTerminationConfigPac" + $ref: "#/definitions/tapi.photonic.media.PowerProperties" 400: description: "Internal error" post: tags: - "tapi-photonic-media" - description: "creates tapi.photonic.media.OtsiTerminationConfigPac" + summary: "creates tapi.photonic.media.PowerProperties" + description: "This parameter shall be used to specify the minimum output power\r\ + \n desired at the Logical-Termination-Point (LTP) associated\ + \ to the CSEP." parameters: - name: "uuid" in: "path" @@ -2564,12 +2675,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.photonic.media.OtsiTerminationConfigPac.body-param" - description: "tapi.photonic.media.OtsiTerminationConfigPac to be added to\ - \ list" + name: "tapi.photonic.media.PowerProperties.body-param" + description: "tapi.photonic.media.PowerProperties to be added to list" required: false schema: - $ref: "#/definitions/tapi.photonic.media.OtsiTerminationConfigPac" + $ref: "#/definitions/tapi.photonic.media.PowerProperties" responses: 201: description: "Object created" @@ -2580,7 +2690,10 @@ paths: put: tags: - "tapi-photonic-media" - description: "creates or updates tapi.photonic.media.OtsiTerminationConfigPac" + summary: "creates or updates tapi.photonic.media.PowerProperties" + description: "This parameter shall be used to specify the minimum output power\r\ + \n desired at the Logical-Termination-Point (LTP) associated\ + \ to the CSEP." parameters: - name: "uuid" in: "path" @@ -2593,12 +2706,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.photonic.media.OtsiTerminationConfigPac.body-param" - description: "tapi.photonic.media.OtsiTerminationConfigPac to be added or\ - \ updated" + name: "tapi.photonic.media.PowerProperties.body-param" + description: "tapi.photonic.media.PowerProperties to be added or updated" required: false schema: - $ref: "#/definitions/tapi.photonic.media.OtsiTerminationConfigPac" + $ref: "#/definitions/tapi.photonic.media.PowerProperties" responses: 201: description: "Object created" @@ -2609,7 +2721,10 @@ paths: delete: tags: - "tapi-photonic-media" - description: "removes tapi.photonic.media.OtsiTerminationConfigPac" + summary: "removes tapi.photonic.media.PowerProperties" + description: "This parameter shall be used to specify the minimum output power\r\ + \n desired at the Logical-Termination-Point (LTP) associated\ + \ to the CSEP." parameters: - name: "uuid" in: "path" @@ -2626,11 +2741,14 @@ paths: description: "Internal error" 204: description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/otsi-connectivity-service-end-point-spec/otsi-config/application-identifier/ - : get: + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/name/: + post: tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.ApplicationIdentifier" + - "tapi-connectivity" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -2642,17 +2760,27 @@ paths: description: "Id of end-point" required: true type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" responses: - 200: - description: "tapi.photonic.media.ApplicationIdentifier" - schema: - $ref: "#/definitions/tapi.photonic.media.ApplicationIdentifier" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/name={value-name}/: + get: tags: - - "tapi-photonic-media" - description: "creates tapi.photonic.media.ApplicationIdentifier" + - "tapi-connectivity" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -2664,23 +2792,25 @@ paths: description: "Id of end-point" required: true type: "string" - - in: "body" - name: "tapi.photonic.media.ApplicationIdentifier.body-param" - description: "tapi.photonic.media.ApplicationIdentifier to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.photonic.media.ApplicationIdentifier" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" responses: - 201: - description: "Object created" + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - - "tapi-photonic-media" - description: "creates or updates tapi.photonic.media.ApplicationIdentifier" + - "tapi-connectivity" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -2692,12 +2822,17 @@ paths: description: "Id of end-point" required: true type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" - in: "body" - name: "tapi.photonic.media.ApplicationIdentifier.body-param" - description: "tapi.photonic.media.ApplicationIdentifier to be added or updated" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.photonic.media.ApplicationIdentifier" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -2707,8 +2842,11 @@ paths: description: "Object modified" delete: tags: - - "tapi-photonic-media" - description: "removes tapi.photonic.media.ApplicationIdentifier" + - "tapi-connectivity" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -2720,16 +2858,22 @@ paths: description: "Id of end-point" required: true type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/otsi-connectivity-service-end-point-spec/otsi-config/central-frequency/ - : get: + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/odu-connectivity-service-end-point-spec/: + get: tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.CentralFrequency" + - "tapi-odu" + summary: "returns tapi.odu.OduConnectivityServiceEndPointSpec" + description: "none" parameters: - name: "uuid" in: "path" @@ -2743,15 +2887,16 @@ paths: type: "string" responses: 200: - description: "tapi.photonic.media.CentralFrequency" + description: "tapi.odu.OduConnectivityServiceEndPointSpec" schema: - $ref: "#/definitions/tapi.photonic.media.CentralFrequency" + $ref: "#/definitions/tapi.odu.OduConnectivityServiceEndPointSpec" 400: description: "Internal error" post: tags: - - "tapi-photonic-media" - description: "creates tapi.photonic.media.CentralFrequency" + - "tapi-odu" + summary: "creates tapi.odu.OduConnectivityServiceEndPointSpec" + description: "none" parameters: - name: "uuid" in: "path" @@ -2764,11 +2909,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.photonic.media.CentralFrequency.body-param" - description: "tapi.photonic.media.CentralFrequency to be added to list" + name: "tapi.odu.OduConnectivityServiceEndPointSpec.body-param" + description: "tapi.odu.OduConnectivityServiceEndPointSpec to be added to list" required: false schema: - $ref: "#/definitions/tapi.photonic.media.CentralFrequency" + $ref: "#/definitions/tapi.odu.OduConnectivityServiceEndPointSpec" responses: 201: description: "Object created" @@ -2778,8 +2923,9 @@ paths: description: "Object already exists" put: tags: - - "tapi-photonic-media" - description: "creates or updates tapi.photonic.media.CentralFrequency" + - "tapi-odu" + summary: "creates or updates tapi.odu.OduConnectivityServiceEndPointSpec" + description: "none" parameters: - name: "uuid" in: "path" @@ -2792,11 +2938,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.photonic.media.CentralFrequency.body-param" - description: "tapi.photonic.media.CentralFrequency to be added or updated" + name: "tapi.odu.OduConnectivityServiceEndPointSpec.body-param" + description: "tapi.odu.OduConnectivityServiceEndPointSpec to be added or updated" required: false schema: - $ref: "#/definitions/tapi.photonic.media.CentralFrequency" + $ref: "#/definitions/tapi.odu.OduConnectivityServiceEndPointSpec" responses: 201: description: "Object created" @@ -2806,8 +2952,9 @@ paths: description: "Object modified" delete: tags: - - "tapi-photonic-media" - description: "removes tapi.photonic.media.CentralFrequency" + - "tapi-odu" + summary: "removes tapi.odu.OduConnectivityServiceEndPointSpec" + description: "none" parameters: - name: "uuid" in: "path" @@ -2824,11 +2971,41 @@ paths: description: "Internal error" 204: description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/otsi-connectivity-service-end-point-spec/otsi-config/central-frequency/frequency-constraint/ + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/odu-connectivity-service-end-point-spec/accepted-payload-type/ : get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.OduPayloadType" + description: "This attribute is applicable when the ODU CTP object instance\ + \ represents a lower order ODU CTP Sink at the client layer of the ODUP/ODU[i]j\ + \ or ODUP/ODUj-21 adaptation function. \r\n This attribute\ + \ is a 2-digit Hex code that indicates the new accepted payload type.\r\n\ + \ Valid values are defined in Table 15-8 of ITU-T Recommendation\ + \ G.709 with one additional value UN_INTERPRETABLE." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.OduPayloadType" + schema: + $ref: "#/definitions/tapi.odu.OduPayloadType" + 400: + description: "Internal error" + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/otsi-connectivity-service-end-point-spec/: + get: tags: - "tapi-photonic-media" - description: "returns tapi.photonic.media.FrequencyConstraint" + summary: "returns tapi.photonic.media.OtsiConnectivityServiceEndPointSpec" + description: "none" parameters: - name: "uuid" in: "path" @@ -2842,15 +3019,16 @@ paths: type: "string" responses: 200: - description: "tapi.photonic.media.FrequencyConstraint" + description: "tapi.photonic.media.OtsiConnectivityServiceEndPointSpec" schema: - $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" + $ref: "#/definitions/tapi.photonic.media.OtsiConnectivityServiceEndPointSpec" 400: description: "Internal error" post: tags: - "tapi-photonic-media" - description: "creates tapi.photonic.media.FrequencyConstraint" + summary: "creates tapi.photonic.media.OtsiConnectivityServiceEndPointSpec" + description: "none" parameters: - name: "uuid" in: "path" @@ -2863,11 +3041,12 @@ paths: required: true type: "string" - in: "body" - name: "tapi.photonic.media.FrequencyConstraint.body-param" - description: "tapi.photonic.media.FrequencyConstraint to be added to list" + name: "tapi.photonic.media.OtsiConnectivityServiceEndPointSpec.body-param" + description: "tapi.photonic.media.OtsiConnectivityServiceEndPointSpec to be\ + \ added to list" required: false schema: - $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" + $ref: "#/definitions/tapi.photonic.media.OtsiConnectivityServiceEndPointSpec" responses: 201: description: "Object created" @@ -2878,7 +3057,8 @@ paths: put: tags: - "tapi-photonic-media" - description: "creates or updates tapi.photonic.media.FrequencyConstraint" + summary: "creates or updates tapi.photonic.media.OtsiConnectivityServiceEndPointSpec" + description: "none" parameters: - name: "uuid" in: "path" @@ -2891,11 +3071,12 @@ paths: required: true type: "string" - in: "body" - name: "tapi.photonic.media.FrequencyConstraint.body-param" - description: "tapi.photonic.media.FrequencyConstraint to be added or updated" + name: "tapi.photonic.media.OtsiConnectivityServiceEndPointSpec.body-param" + description: "tapi.photonic.media.OtsiConnectivityServiceEndPointSpec to be\ + \ added or updated" required: false schema: - $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" + $ref: "#/definitions/tapi.photonic.media.OtsiConnectivityServiceEndPointSpec" responses: 201: description: "Object created" @@ -2906,7 +3087,8 @@ paths: delete: tags: - "tapi-photonic-media" - description: "removes tapi.photonic.media.FrequencyConstraint" + summary: "removes tapi.photonic.media.OtsiConnectivityServiceEndPointSpec" + description: "none" parameters: - name: "uuid" in: "path" @@ -2923,11 +3105,12 @@ paths: description: "Internal error" 204: description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/otsi-connectivity-service-end-point-spec/otsi-config/spectrum/ + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/otsi-connectivity-service-end-point-spec/otsi-config/ : get: tags: - "tapi-photonic-media" - description: "returns tapi.photonic.media.SpectrumBand" + summary: "returns tapi.photonic.media.OtsiTerminationConfigPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -2941,15 +3124,16 @@ paths: type: "string" responses: 200: - description: "tapi.photonic.media.SpectrumBand" + description: "tapi.photonic.media.OtsiTerminationConfigPac" schema: - $ref: "#/definitions/tapi.photonic.media.SpectrumBand" + $ref: "#/definitions/tapi.photonic.media.OtsiTerminationConfigPac" 400: description: "Internal error" post: tags: - "tapi-photonic-media" - description: "creates tapi.photonic.media.SpectrumBand" + summary: "creates tapi.photonic.media.OtsiTerminationConfigPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -2962,11 +3146,12 @@ paths: required: true type: "string" - in: "body" - name: "tapi.photonic.media.SpectrumBand.body-param" - description: "tapi.photonic.media.SpectrumBand to be added to list" + name: "tapi.photonic.media.OtsiTerminationConfigPac.body-param" + description: "tapi.photonic.media.OtsiTerminationConfigPac to be added to\ + \ list" required: false schema: - $ref: "#/definitions/tapi.photonic.media.SpectrumBand" + $ref: "#/definitions/tapi.photonic.media.OtsiTerminationConfigPac" responses: 201: description: "Object created" @@ -2977,7 +3162,8 @@ paths: put: tags: - "tapi-photonic-media" - description: "creates or updates tapi.photonic.media.SpectrumBand" + summary: "creates or updates tapi.photonic.media.OtsiTerminationConfigPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -2990,11 +3176,12 @@ paths: required: true type: "string" - in: "body" - name: "tapi.photonic.media.SpectrumBand.body-param" - description: "tapi.photonic.media.SpectrumBand to be added or updated" + name: "tapi.photonic.media.OtsiTerminationConfigPac.body-param" + description: "tapi.photonic.media.OtsiTerminationConfigPac to be added or\ + \ updated" required: false schema: - $ref: "#/definitions/tapi.photonic.media.SpectrumBand" + $ref: "#/definitions/tapi.photonic.media.OtsiTerminationConfigPac" responses: 201: description: "Object created" @@ -3005,7 +3192,8 @@ paths: delete: tags: - "tapi-photonic-media" - description: "removes tapi.photonic.media.SpectrumBand" + summary: "removes tapi.photonic.media.OtsiTerminationConfigPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -3022,11 +3210,12 @@ paths: description: "Internal error" 204: description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/otsi-connectivity-service-end-point-spec/otsi-config/spectrum/frequency-constraint/ + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/otsi-connectivity-service-end-point-spec/otsi-config/application-identifier/ : get: tags: - "tapi-photonic-media" - description: "returns tapi.photonic.media.FrequencyConstraint" + summary: "returns tapi.photonic.media.ApplicationIdentifier" + description: "This attribute indicates the selected Application Identifier." parameters: - name: "uuid" in: "path" @@ -3040,15 +3229,16 @@ paths: type: "string" responses: 200: - description: "tapi.photonic.media.FrequencyConstraint" + description: "tapi.photonic.media.ApplicationIdentifier" schema: - $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" + $ref: "#/definitions/tapi.photonic.media.ApplicationIdentifier" 400: description: "Internal error" post: tags: - "tapi-photonic-media" - description: "creates tapi.photonic.media.FrequencyConstraint" + summary: "creates tapi.photonic.media.ApplicationIdentifier" + description: "This attribute indicates the selected Application Identifier." parameters: - name: "uuid" in: "path" @@ -3061,11 +3251,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.photonic.media.FrequencyConstraint.body-param" - description: "tapi.photonic.media.FrequencyConstraint to be added to list" + name: "tapi.photonic.media.ApplicationIdentifier.body-param" + description: "tapi.photonic.media.ApplicationIdentifier to be added to list" required: false schema: - $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" + $ref: "#/definitions/tapi.photonic.media.ApplicationIdentifier" responses: 201: description: "Object created" @@ -3076,7 +3266,8 @@ paths: put: tags: - "tapi-photonic-media" - description: "creates or updates tapi.photonic.media.FrequencyConstraint" + summary: "creates or updates tapi.photonic.media.ApplicationIdentifier" + description: "This attribute indicates the selected Application Identifier." parameters: - name: "uuid" in: "path" @@ -3089,11 +3280,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.photonic.media.FrequencyConstraint.body-param" - description: "tapi.photonic.media.FrequencyConstraint to be added or updated" + name: "tapi.photonic.media.ApplicationIdentifier.body-param" + description: "tapi.photonic.media.ApplicationIdentifier to be added or updated" required: false schema: - $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" + $ref: "#/definitions/tapi.photonic.media.ApplicationIdentifier" responses: 201: description: "Object created" @@ -3104,7 +3295,8 @@ paths: delete: tags: - "tapi-photonic-media" - description: "removes tapi.photonic.media.FrequencyConstraint" + summary: "removes tapi.photonic.media.ApplicationIdentifier" + description: "This attribute indicates the selected Application Identifier." parameters: - name: "uuid" in: "path" @@ -3121,11 +3313,13 @@ paths: description: "Internal error" 204: description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/otsi-connectivity-service-end-point-spec/otsi-config/transmit-power/ + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/otsi-connectivity-service-end-point-spec/otsi-config/central-frequency/ : get: tags: - "tapi-photonic-media" - description: "returns tapi.photonic.media.PowerPropertiesPac" + summary: "returns tapi.photonic.media.CentralFrequency" + description: "The central frequency of the laser. It is the oscillation frequency\ + \ of the corresponding electromagnetic wave" parameters: - name: "uuid" in: "path" @@ -3139,15 +3333,17 @@ paths: type: "string" responses: 200: - description: "tapi.photonic.media.PowerPropertiesPac" + description: "tapi.photonic.media.CentralFrequency" schema: - $ref: "#/definitions/tapi.photonic.media.PowerPropertiesPac" + $ref: "#/definitions/tapi.photonic.media.CentralFrequency" 400: description: "Internal error" post: tags: - "tapi-photonic-media" - description: "creates tapi.photonic.media.PowerPropertiesPac" + summary: "creates tapi.photonic.media.CentralFrequency" + description: "The central frequency of the laser. It is the oscillation frequency\ + \ of the corresponding electromagnetic wave" parameters: - name: "uuid" in: "path" @@ -3160,11 +3356,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.photonic.media.PowerPropertiesPac.body-param" - description: "tapi.photonic.media.PowerPropertiesPac to be added to list" + name: "tapi.photonic.media.CentralFrequency.body-param" + description: "tapi.photonic.media.CentralFrequency to be added to list" required: false schema: - $ref: "#/definitions/tapi.photonic.media.PowerPropertiesPac" + $ref: "#/definitions/tapi.photonic.media.CentralFrequency" responses: 201: description: "Object created" @@ -3175,7 +3371,9 @@ paths: put: tags: - "tapi-photonic-media" - description: "creates or updates tapi.photonic.media.PowerPropertiesPac" + summary: "creates or updates tapi.photonic.media.CentralFrequency" + description: "The central frequency of the laser. It is the oscillation frequency\ + \ of the corresponding electromagnetic wave" parameters: - name: "uuid" in: "path" @@ -3188,11 +3386,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.photonic.media.PowerPropertiesPac.body-param" - description: "tapi.photonic.media.PowerPropertiesPac to be added or updated" + name: "tapi.photonic.media.CentralFrequency.body-param" + description: "tapi.photonic.media.CentralFrequency to be added or updated" required: false schema: - $ref: "#/definitions/tapi.photonic.media.PowerPropertiesPac" + $ref: "#/definitions/tapi.photonic.media.CentralFrequency" responses: 201: description: "Object created" @@ -3203,7 +3401,9 @@ paths: delete: tags: - "tapi-photonic-media" - description: "removes tapi.photonic.media.PowerPropertiesPac" + summary: "removes tapi.photonic.media.CentralFrequency" + description: "The central frequency of the laser. It is the oscillation frequency\ + \ of the corresponding electromagnetic wave" parameters: - name: "uuid" in: "path" @@ -3220,11 +3420,12 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/service-interface-point/: - get: + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/otsi-connectivity-service-end-point-spec/otsi-config/central-frequency/frequency-constraint/ + : get: tags: - - "tapi-connectivity" - description: "returns tapi.common.ServiceInterfacePointRef" + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.FrequencyConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -3238,15 +3439,16 @@ paths: type: "string" responses: 200: - description: "tapi.common.ServiceInterfacePointRef" + description: "tapi.photonic.media.FrequencyConstraint" schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" 400: description: "Internal error" post: tags: - - "tapi-connectivity" - description: "creates tapi.common.ServiceInterfacePointRef" + - "tapi-photonic-media" + summary: "creates tapi.photonic.media.FrequencyConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -3259,11 +3461,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.ServiceInterfacePointRef.body-param" - description: "tapi.common.ServiceInterfacePointRef to be added to list" + name: "tapi.photonic.media.FrequencyConstraint.body-param" + description: "tapi.photonic.media.FrequencyConstraint to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" responses: 201: description: "Object created" @@ -3273,8 +3475,9 @@ paths: description: "Object already exists" put: tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.ServiceInterfacePointRef" + - "tapi-photonic-media" + summary: "creates or updates tapi.photonic.media.FrequencyConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -3287,11 +3490,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.ServiceInterfacePointRef.body-param" - description: "tapi.common.ServiceInterfacePointRef to be added or updated" + name: "tapi.photonic.media.FrequencyConstraint.body-param" + description: "tapi.photonic.media.FrequencyConstraint to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" responses: 201: description: "Object created" @@ -3301,8 +3504,9 @@ paths: description: "Object modified" delete: tags: - - "tapi-connectivity" - description: "removes tapi.common.ServiceInterfacePointRef" + - "tapi-photonic-media" + summary: "removes tapi.photonic.media.FrequencyConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -3319,255 +3523,258 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/exclude-link={topology-uuid},{link-uuid}/: - get: + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/otsi-connectivity-service-end-point-spec/otsi-config/spectrum/ + : get: tags: - - "tapi-connectivity" - description: "returns tapi.topology.LinkRef" + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.SpectrumBand" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of exclude-link" - required: true - type: "string" - - name: "link-uuid" + - name: "local-id" in: "path" - description: "Id of exclude-link" + description: "Id of end-point" required: true type: "string" responses: 200: - description: "tapi.topology.LinkRef" + description: "tapi.photonic.media.SpectrumBand" schema: - $ref: "#/definitions/tapi.topology.LinkRef" + $ref: "#/definitions/tapi.photonic.media.SpectrumBand" 400: description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/exclude-node={topology-uuid},{node-uuid}/: - get: + post: tags: - - "tapi-connectivity" - description: "returns tapi.topology.NodeRef" + - "tapi-photonic-media" + summary: "creates tapi.photonic.media.SpectrumBand" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of exclude-node" - required: true - type: "string" - - name: "node-uuid" + - name: "local-id" in: "path" - description: "Id of exclude-node" + description: "Id of end-point" required: true type: "string" + - in: "body" + name: "tapi.photonic.media.SpectrumBand.body-param" + description: "tapi.photonic.media.SpectrumBand to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.SpectrumBand" responses: - 200: - description: "tapi.topology.NodeRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRef" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/exclude-path={path-uuid}/: - get: + 409: + description: "Object already exists" + put: tags: - - "tapi-connectivity" - description: "returns tapi.path.computation.PathRef" + - "tapi-photonic-media" + summary: "creates or updates tapi.photonic.media.SpectrumBand" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "path-uuid" + - name: "local-id" in: "path" - description: "Id of exclude-path" + description: "Id of end-point" required: true type: "string" + - in: "body" + name: "tapi.photonic.media.SpectrumBand.body-param" + description: "tapi.photonic.media.SpectrumBand to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.SpectrumBand" responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/include-link={topology-uuid},{link-uuid}/: - get: + 204: + description: "Object modified" + delete: tags: - - "tapi-connectivity" - description: "returns tapi.topology.LinkRef" + - "tapi-photonic-media" + summary: "removes tapi.photonic.media.SpectrumBand" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-link" - required: true - type: "string" - - name: "link-uuid" + - name: "local-id" in: "path" - description: "Id of include-link" + description: "Id of end-point" required: true type: "string" responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" 400: description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/include-node={topology-uuid},{node-uuid}/: - get: + 204: + description: "Object deleted" + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/otsi-connectivity-service-end-point-spec/otsi-config/spectrum/frequency-constraint/ + : get: tags: - - "tapi-connectivity" - description: "returns tapi.topology.NodeRef" + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.FrequencyConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-node" - required: true - type: "string" - - name: "node-uuid" + - name: "local-id" in: "path" - description: "Id of include-node" + description: "Id of end-point" required: true type: "string" responses: 200: - description: "tapi.topology.NodeRef" + description: "tapi.photonic.media.FrequencyConstraint" schema: - $ref: "#/definitions/tapi.topology.NodeRef" + $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" 400: description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/include-path={path-uuid}/: - get: + post: tags: - - "tapi-connectivity" - description: "returns tapi.path.computation.PathRef" + - "tapi-photonic-media" + summary: "creates tapi.photonic.media.FrequencyConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "path-uuid" + - name: "local-id" in: "path" - description: "Id of include-path" + description: "Id of end-point" required: true type: "string" + - in: "body" + name: "tapi.photonic.media.FrequencyConstraint.body-param" + description: "tapi.photonic.media.FrequencyConstraint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/include-topology={topology-uuid}/: - get: + 409: + description: "Object already exists" + put: tags: - - "tapi-connectivity" - description: "returns tapi.topology.TopologyRef" + - "tapi-photonic-media" + summary: "creates or updates tapi.photonic.media.FrequencyConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "topology-uuid" + - name: "local-id" in: "path" - description: "Id of include-topology" + description: "Id of end-point" required: true type: "string" + - in: "body" + name: "tapi.photonic.media.FrequencyConstraint.body-param" + description: "tapi.photonic.media.FrequencyConstraint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/latency-characteristic/: - post: + 204: + description: "Object modified" + delete: tags: - - "tapi-connectivity" - description: "creates tapi.topology.LatencyCharacteristic" + - "tapi-photonic-media" + summary: "removes tapi.photonic.media.FrequencyConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" responses: - 201: - description: "Object created" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/latency-characteristic={traffic-property-name}/: - get: + 204: + description: "Object deleted" + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/otsi-connectivity-service-end-point-spec/otsi-config/transmit-power/ + : get: tags: - - "tapi-connectivity" - description: "returns tapi.topology.LatencyCharacteristic" + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.PowerProperties" + description: "Transmit power as requested." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "traffic-property-name" + - name: "local-id" in: "path" - description: "Id of latency-characteristic" + description: "Id of end-point" required: true type: "string" responses: 200: - description: "tapi.topology.LatencyCharacteristic" + description: "tapi.photonic.media.PowerProperties" schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + $ref: "#/definitions/tapi.photonic.media.PowerProperties" 400: description: "Internal error" post: tags: - - "tapi-connectivity" - description: "creates tapi.topology.LatencyCharacteristic" + - "tapi-photonic-media" + summary: "creates tapi.photonic.media.PowerProperties" + description: "Transmit power as requested." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "traffic-property-name" + - name: "local-id" in: "path" - description: "Id of latency-characteristic" + description: "Id of end-point" required: true type: "string" - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" + name: "tapi.photonic.media.PowerProperties.body-param" + description: "tapi.photonic.media.PowerProperties to be added to list" required: false schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + $ref: "#/definitions/tapi.photonic.media.PowerProperties" responses: 201: description: "Object created" @@ -3577,25 +3784,26 @@ paths: description: "Object already exists" put: tags: - - "tapi-connectivity" - description: "creates or updates tapi.topology.LatencyCharacteristic" + - "tapi-photonic-media" + summary: "creates or updates tapi.photonic.media.PowerProperties" + description: "Transmit power as requested." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "traffic-property-name" + - name: "local-id" in: "path" - description: "Id of latency-characteristic" + description: "Id of end-point" required: true type: "string" - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added or updated" + name: "tapi.photonic.media.PowerProperties.body-param" + description: "tapi.photonic.media.PowerProperties to be added or updated" required: false schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + $ref: "#/definitions/tapi.photonic.media.PowerProperties" responses: 201: description: "Object created" @@ -3605,17 +3813,18 @@ paths: description: "Object modified" delete: tags: - - "tapi-connectivity" - description: "removes tapi.topology.LatencyCharacteristic" + - "tapi-photonic-media" + summary: "removes tapi.photonic.media.PowerProperties" + description: "Transmit power as requested." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "traffic-property-name" + - name: "local-id" in: "path" - description: "Id of latency-characteristic" + description: "Id of end-point" required: true type: "string" responses: @@ -3623,74 +3832,53 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/name/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/name={value-name}/: + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/peer-fwd-connectivity-service-end-point/: get: tags: - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of name" + description: "Id of end-point" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.connectivity.ConnectivityServiceEndPointRef" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" 400: description: "Internal error" post: tags: - "tapi-connectivity" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of name" + description: "Id of end-point" required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ to list" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" responses: 201: description: "Object created" @@ -3701,24 +3889,26 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.NameAndValue" + summary: "creates or updates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of name" + description: "Id of end-point" required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ or updated" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" responses: 201: description: "Object created" @@ -3729,16 +3919,17 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of name" + description: "Id of end-point" required: true type: "string" responses: @@ -3746,40 +3937,53 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/: + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/protecting-connectivity-service-end-point/: get: tags: - "tapi-connectivity" - description: "returns tapi.common.Capacity" + summary: "returns tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" responses: 200: - description: "tapi.common.Capacity" + description: "tapi.connectivity.ConnectivityServiceEndPointRef" schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" 400: description: "Internal error" post: tags: - "tapi-connectivity" - description: "creates tapi.common.Capacity" + summary: "creates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" - in: "body" - name: "tapi.common.Capacity.body-param" - description: "tapi.common.Capacity to be added to list" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ to list" required: false schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" responses: 201: description: "Object created" @@ -3790,19 +3994,26 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.Capacity" + summary: "creates or updates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" - in: "body" - name: "tapi.common.Capacity.body-param" - description: "tapi.common.Capacity to be added or updated" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ or updated" required: false schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" responses: 201: description: "Object created" @@ -3813,52 +4024,71 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.Capacity" + summary: "removes tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/: + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/server-connectivity-service-end-point/: get: tags: - "tapi-connectivity" - description: "returns tapi.common.BandwidthProfile" + summary: "returns tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.connectivity.ConnectivityServiceEndPointRef" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" 400: description: "Internal error" post: tags: - "tapi-connectivity" - description: "creates tapi.common.BandwidthProfile" + summary: "creates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" - in: "body" - name: "tapi.common.BandwidthProfile.body-param" - description: "tapi.common.BandwidthProfile to be added to list" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ to list" required: false schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" responses: 201: description: "Object created" @@ -3869,19 +4099,26 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.BandwidthProfile" + summary: "creates or updates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" - in: "body" - name: "tapi.common.BandwidthProfile.body-param" - description: "tapi.common.BandwidthProfile to be added or updated" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ or updated" required: false schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" responses: 201: description: "Object created" @@ -3892,52 +4129,70 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.BandwidthProfile" + summary: "removes tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/committed-burst-size/: + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/service-interface-point/: get: tags: - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.ServiceInterfacePointRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" 400: description: "Internal error" post: tags: - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + summary: "creates tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.common.ServiceInterfacePointRef.body-param" + description: "tapi.common.ServiceInterfacePointRef to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" responses: 201: description: "Object created" @@ -3948,19 +4203,25 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.common.ServiceInterfacePointRef.body-param" + description: "tapi.common.ServiceInterfacePointRef to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" responses: 201: description: "Object created" @@ -3971,75 +4232,101 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/committed-information-rate/: - get: + /data/context/connectivity-context/connectivity-service={uuid}/name/: + post: tags: - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/name={value-name}/: + get: tags: - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" responses: - 201: - description: "Object created" + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -4050,23 +4337,32 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/peak-burst-size/: + /data/context/connectivity-context/connectivity-service={uuid}/resilience-constraint/: get: tags: - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.connectivity.ResilienceConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -4075,15 +4371,16 @@ paths: type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.connectivity.ResilienceConstraint" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" 400: description: "Internal error" post: tags: - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + summary: "creates tapi.connectivity.ResilienceConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -4091,11 +4388,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.connectivity.ResilienceConstraint.body-param" + description: "tapi.connectivity.ResilienceConstraint to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" responses: 201: description: "Object created" @@ -4106,7 +4403,8 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.connectivity.ResilienceConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -4114,11 +4412,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.connectivity.ResilienceConstraint.body-param" + description: "tapi.connectivity.ResilienceConstraint to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" responses: 201: description: "Object created" @@ -4129,7 +4427,8 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.connectivity.ResilienceConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -4141,11 +4440,12 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/peak-information-rate/: + /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/: get: tags: - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.path.computation.RoutingConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -4154,15 +4454,16 @@ paths: type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.path.computation.RoutingConstraint" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" 400: description: "Internal error" post: tags: - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + summary: "creates tapi.path.computation.RoutingConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -4170,11 +4471,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.path.computation.RoutingConstraint.body-param" + description: "tapi.path.computation.RoutingConstraint to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" responses: 201: description: "Object created" @@ -4185,7 +4486,8 @@ paths: put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.path.computation.RoutingConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -4193,11 +4495,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.path.computation.RoutingConstraint.body-param" + description: "tapi.path.computation.RoutingConstraint to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" responses: 201: description: "Object created" @@ -4208,7 +4510,8 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.path.computation.RoutingConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -4220,63 +4523,80 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/total-size/: - get: + /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/cost-characteristic/: + post: tags: - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" + summary: "creates tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - in: "body" + name: "tapi.topology.CostCharacteristic.body-param" + description: "tapi.topology.CostCharacteristic to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/cost-characteristic={cost-name}/: + get: tags: - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" responses: - 201: - description: "Object created" + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.topology.CostCharacteristic.body-param" + description: "tapi.topology.CostCharacteristic to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.CostCharacteristic" responses: 201: description: "Object created" @@ -4287,40 +4607,32 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/resilience-type/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.ResilienceType" - parameters: - - name: "uuid" + - name: "cost-name" in: "path" - description: "Id of connectivity-service" + description: "Id of cost-characteristic" required: true type: "string" responses: - 200: - description: "tapi.topology.ResilienceType" - schema: - $ref: "#/definitions/tapi.topology.ResilienceType" 400: description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/latency-characteristic/: post: tags: - "tapi-connectivity" - description: "creates tapi.topology.ResilienceType" + summary: "creates tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" @@ -4328,11 +4640,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.topology.ResilienceType.body-param" - description: "tapi.topology.ResilienceType to be added to list" + name: "tapi.topology.LatencyCharacteristic.body-param" + description: "tapi.topology.LatencyCharacteristic to be added to list" required: false schema: - $ref: "#/definitions/tapi.topology.ResilienceType" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" responses: 201: description: "Object created" @@ -4340,22 +4652,54 @@ paths: description: "Internal error" 409: description: "Object already exists" + ? /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/ + : get: + tags: + - "tapi-connectivity" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" put: tags: - "tapi-connectivity" - description: "creates or updates tapi.topology.ResilienceType" + summary: "creates or updates tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" - in: "body" - name: "tapi.topology.ResilienceType.body-param" - description: "tapi.topology.ResilienceType to be added or updated" + name: "tapi.topology.LatencyCharacteristic.body-param" + description: "tapi.topology.LatencyCharacteristic to be added or updated" required: false schema: - $ref: "#/definitions/tapi.topology.ResilienceType" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" responses: 201: description: "Object created" @@ -4366,23 +4710,31 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.topology.ResilienceType" + summary: "removes tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/risk-diversity-characteristic/: + /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/risk-diversity-characteristic/: post: tags: - "tapi-connectivity" - description: "creates tapi.topology.RiskCharacteristic" + summary: "creates tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" @@ -4402,11 +4754,12 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/risk-diversity-characteristic={risk-characteristic-name}/: - get: + ? /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/ + : get: tags: - "tapi-connectivity" - description: "returns tapi.topology.RiskCharacteristic" + summary: "returns tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" @@ -4425,10 +4778,11 @@ paths: $ref: "#/definitions/tapi.topology.RiskCharacteristic" 400: description: "Internal error" - post: + put: tags: - "tapi-connectivity" - description: "creates tapi.topology.RiskCharacteristic" + summary: "creates or updates tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" @@ -4442,7 +4796,7 @@ paths: type: "string" - in: "body" name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added to list" + description: "tapi.topology.RiskCharacteristic to be added or updated" required: false schema: $ref: "#/definitions/tapi.topology.RiskCharacteristic" @@ -4451,12 +4805,13 @@ paths: description: "Object created" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + 204: + description: "Object modified" + delete: tags: - "tapi-connectivity" - description: "creates or updates tapi.topology.RiskCharacteristic" + summary: "removes tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" @@ -4468,73 +4823,135 @@ paths: description: "Id of risk-diversity-characteristic" required: true type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/topology-constraint/: + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.path.computation.TopologyConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added or updated" + name: "tapi.path.computation.TopologyConstraint.body-param" + description: "tapi.path.computation.TopologyConstraint to be added to list" required: false schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" responses: 201: description: "Object created" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/topology-constraint={local-id}/: + get: tags: - "tapi-connectivity" - description: "removes tapi.topology.RiskCharacteristic" + summary: "returns tapi.path.computation.TopologyConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - - name: "risk-characteristic-name" + - name: "local-id" in: "path" - description: "Id of risk-diversity-characteristic" + description: "Id of topology-constraint" + required: true + type: "string" + responses: + 200: + description: "tapi.path.computation.TopologyConstraint" + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + 400: + description: "Internal error" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.path.computation.TopologyConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" required: true type: "string" + - in: "body" + name: "tapi.path.computation.TopologyConstraint.body-param" + description: "tapi.path.computation.TopologyConstraint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" responses: + 201: + description: "Object created" 400: description: "Internal error" 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/schedule/: - get: + description: "Object modified" + delete: tags: - "tapi-connectivity" - description: "returns tapi.common.TimeRange" + summary: "removes tapi.path.computation.TopologyConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" responses: - 200: - description: "tapi.common.TimeRange" - schema: - $ref: "#/definitions/tapi.common.TimeRange" 400: description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/topology-constraint={local-id}/name/: post: tags: - "tapi-connectivity" - description: "creates tapi.common.TimeRange" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" - in: "body" - name: "tapi.common.TimeRange.body-param" - description: "tapi.common.TimeRange to be added to list" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.TimeRange" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -4542,22 +4959,66 @@ paths: description: "Internal error" 409: description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/topology-constraint={local-id}/name={value-name}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" put: tags: - "tapi-connectivity" - description: "creates or updates tapi.common.TimeRange" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" - in: "body" - name: "tapi.common.TimeRange.body-param" - description: "tapi.common.TimeRange to be added or updated" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.TimeRange" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -4568,13 +5029,26 @@ paths: delete: tags: - "tapi-connectivity" - description: "removes tapi.common.TimeRange" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" responses: 400: description: "Internal error" @@ -4584,7 +5058,10 @@ paths: post: tags: - "tapi-common" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - in: "body" name: "tapi.common.NameAndValue.body-param" @@ -4603,7 +5080,10 @@ paths: get: tags: - "tapi-common" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "value-name" in: "path" @@ -4617,33 +5097,13 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-common" - description: "creates or updates tapi.common.NameAndValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "value-name" in: "path" @@ -4666,7 +5126,10 @@ paths: delete: tags: - "tapi-common" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "value-name" in: "path" @@ -4682,26 +5145,29 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.notification.NotificationContext" + summary: "returns tapi.notification.context.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" parameters: [] responses: 200: - description: "tapi.notification.NotificationContext" + description: "tapi.notification.context.NotificationContext" schema: - $ref: "#/definitions/tapi.notification.NotificationContext" + $ref: "#/definitions/tapi.notification.context.NotificationContext" 400: description: "Internal error" post: tags: - "tapi-notification" - description: "creates tapi.notification.NotificationContext" + summary: "creates tapi.notification.context.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" parameters: - in: "body" - name: "tapi.notification.NotificationContext.body-param" - description: "tapi.notification.NotificationContext to be added to list" + name: "tapi.notification.context.NotificationContext.body-param" + description: "tapi.notification.context.NotificationContext to be added to\ + \ list" required: false schema: - $ref: "#/definitions/tapi.notification.NotificationContext" + $ref: "#/definitions/tapi.notification.context.NotificationContext" responses: 201: description: "Object created" @@ -4712,14 +5178,16 @@ paths: put: tags: - "tapi-notification" - description: "creates or updates tapi.notification.NotificationContext" + summary: "creates or updates tapi.notification.context.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" parameters: - in: "body" - name: "tapi.notification.NotificationContext.body-param" - description: "tapi.notification.NotificationContext to be added or updated" + name: "tapi.notification.context.NotificationContext.body-param" + description: "tapi.notification.context.NotificationContext to be added or\ + \ updated" required: false schema: - $ref: "#/definitions/tapi.notification.NotificationContext" + $ref: "#/definitions/tapi.notification.context.NotificationContext" responses: 201: description: "Object created" @@ -4730,7 +5198,8 @@ paths: delete: tags: - "tapi-notification" - description: "removes tapi.notification.NotificationContext" + summary: "removes tapi.notification.context.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" parameters: [] responses: 400: @@ -4741,7 +5210,8 @@ paths: post: tags: - "tapi-notification" - description: "creates tapi.notification.NotificationSubscriptionService" + summary: "creates tapi.notification.NotificationSubscriptionService" + description: "none" parameters: - in: "body" name: "tapi.notification.NotificationSubscriptionService.body-param" @@ -4761,7 +5231,8 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.notification.NotificationSubscriptionService" + summary: "returns tapi.notification.NotificationSubscriptionService" + description: "none" parameters: - name: "uuid" in: "path" @@ -4775,34 +5246,11 @@ paths: $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" 400: description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationSubscriptionService" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationSubscriptionService.body-param" - description: "tapi.notification.NotificationSubscriptionService to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-notification" - description: "creates or updates tapi.notification.NotificationSubscriptionService" + summary: "creates or updates tapi.notification.NotificationSubscriptionService" + description: "none" parameters: - name: "uuid" in: "path" @@ -4826,7 +5274,8 @@ paths: delete: tags: - "tapi-notification" - description: "removes tapi.notification.NotificationSubscriptionService" + summary: "removes tapi.notification.NotificationSubscriptionService" + description: "none" parameters: - name: "uuid" in: "path" @@ -4842,7 +5291,10 @@ paths: post: tags: - "tapi-notification" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -4866,7 +5318,10 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -4885,10 +5340,13 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: + put: tags: - "tapi-notification" - description: "creates tapi.common.NameAndValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -4902,35 +5360,7 @@ paths: type: "string" - in: "body" name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: $ref: "#/definitions/tapi.common.NameAndValue" @@ -4944,7 +5374,10 @@ paths: delete: tags: - "tapi-notification" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -4965,7 +5398,8 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.notification.NotificationChannel" + summary: "returns tapi.notification.NotificationChannel" + description: "none" parameters: - name: "uuid" in: "path" @@ -4979,96 +5413,14 @@ paths: $ref: "#/definitions/tapi.notification.NotificationChannel" 400: description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationChannel.body-param" - description: "tapi.notification.NotificationChannel to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationChannel.body-param" - description: "tapi.notification.NotificationChannel to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/notification-channel/name/: - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" /data/context/notification-context/notif-subscription={uuid}/notification-channel/name={value-name}/: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -5087,87 +5439,12 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/: get: tags: - "tapi-notification" - description: "returns tapi.notification.Notification" + summary: "returns tapi.notification.Notification" + description: "none" parameters: - name: "uuid" in: "path" @@ -5190,7 +5467,8 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -5214,34 +5492,12 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/alarm-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.AlarmInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.AlarmInfo" - schema: - $ref: "#/definitions/tapi.notification.AlarmInfo" - 400: - description: "Internal error" /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/changed-attributes={value-name}/: get: tags: - "tapi-notification" - description: "returns tapi.notification.NameAndValueChange" + summary: "returns tapi.notification.NameAndValueChange" + description: "none" parameters: - name: "uuid" in: "path" @@ -5269,7 +5525,10 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -5297,7 +5556,8 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -5321,34 +5581,12 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/tca-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.TcaInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.TcaInfo" - schema: - $ref: "#/definitions/tapi.notification.TcaInfo" - 400: - description: "Internal error" /data/context/notification-context/notif-subscription={uuid}/subscription-filter/: get: tags: - "tapi-notification" - description: "returns tapi.notification.SubscriptionFilter" + summary: "returns tapi.notification.SubscriptionFilter" + description: "none" parameters: - name: "uuid" in: "path" @@ -5365,7 +5603,8 @@ paths: post: tags: - "tapi-notification" - description: "creates tapi.notification.SubscriptionFilter" + summary: "creates tapi.notification.SubscriptionFilter" + description: "none" parameters: - name: "uuid" in: "path" @@ -5388,7 +5627,8 @@ paths: put: tags: - "tapi-notification" - description: "creates or updates tapi.notification.SubscriptionFilter" + summary: "creates or updates tapi.notification.SubscriptionFilter" + description: "none" parameters: - name: "uuid" in: "path" @@ -5411,7 +5651,8 @@ paths: delete: tags: - "tapi-notification" - description: "removes tapi.notification.SubscriptionFilter" + summary: "removes tapi.notification.SubscriptionFilter" + description: "none" parameters: - name: "uuid" in: "path" @@ -5427,7 +5668,10 @@ paths: post: tags: - "tapi-notification" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -5451,7 +5695,10 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -5470,38 +5717,13 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -5529,7 +5751,10 @@ paths: delete: tags: - "tapi-notification" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -5550,7 +5775,8 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.notification.Notification" + summary: "returns tapi.notification.notificationcontext.Notification" + description: "none" parameters: - name: "uuid" in: "path" @@ -5559,16 +5785,17 @@ paths: type: "string" responses: 200: - description: "tapi.notification.Notification" + description: "tapi.notification.notificationcontext.Notification" schema: - $ref: "#/definitions/tapi.notification.Notification" + $ref: "#/definitions/tapi.notification.notificationcontext.Notification" 400: description: "Internal error" /data/context/notification-context/notification={uuid}/additional-info={value-name}/: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -5590,9 +5817,10 @@ paths: /data/context/notification-context/notification={uuid}/alarm-info/: get: tags: - - "tapi-notification" - description: "returns tapi.notification.AlarmInfo" - parameters: + - "tapi-oam" + summary: "returns tapi.oam.AlarmInfo" + description: "none" + parameters: - name: "uuid" in: "path" description: "Id of notification" @@ -5600,16 +5828,17 @@ paths: type: "string" responses: 200: - description: "tapi.notification.AlarmInfo" + description: "tapi.oam.AlarmInfo" schema: - $ref: "#/definitions/tapi.notification.AlarmInfo" + $ref: "#/definitions/tapi.oam.AlarmInfo" 400: description: "Internal error" /data/context/notification-context/notification={uuid}/changed-attributes={value-name}/: get: tags: - "tapi-notification" - description: "returns tapi.notification.NameAndValueChange" + summary: "returns tapi.notification.NameAndValueChange" + description: "none" parameters: - name: "uuid" in: "path" @@ -5632,7 +5861,10 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -5655,7 +5887,8 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -5677,8 +5910,105 @@ paths: /data/context/notification-context/notification={uuid}/tca-info/: get: tags: - - "tapi-notification" - description: "returns tapi.notification.TcaInfo" + - "tapi-oam" + summary: "returns tapi.oam.TcaInfo" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.TcaInfo" + schema: + $ref: "#/definitions/tapi.oam.TcaInfo" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/tca-info/oam-job/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.OamJobRef" + description: "MEF 35.1\r\n Identification of the PM Session for\ + \ which the TCA Function was configured." + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.OamJobRef" + schema: + $ref: "#/definitions/tapi.oam.OamJobRef" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/tca-info/threshold-parameter/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.ThresholdParameter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.ThresholdParameter" + schema: + $ref: "#/definitions/tapi.oam.ThresholdParameter" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/tca-info/threshold-parameter/pm-parameter-above-thrs/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.PmParameterValue" + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/tca-info/threshold-parameter/pm-parameter-below-thrs/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.PmParameterValue" + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/tca-info/threshold-parameter/pm-parameter-clear-thrs/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -5687,35 +6017,37 @@ paths: type: "string" responses: 200: - description: "tapi.notification.TcaInfo" + description: "tapi.oam.PmParameterValue" schema: - $ref: "#/definitions/tapi.notification.TcaInfo" + $ref: "#/definitions/tapi.oam.PmParameterValue" 400: description: "Internal error" /data/context/oam-context/: get: tags: - "tapi-oam" - description: "returns tapi.oam.OamContext" + summary: "returns tapi.oam.context.OamContext" + description: "Augments the base TAPI Context with OamService information" parameters: [] responses: 200: - description: "tapi.oam.OamContext" + description: "tapi.oam.context.OamContext" schema: - $ref: "#/definitions/tapi.oam.OamContext" + $ref: "#/definitions/tapi.oam.context.OamContext" 400: description: "Internal error" post: tags: - "tapi-oam" - description: "creates tapi.oam.OamContext" + summary: "creates tapi.oam.context.OamContext" + description: "Augments the base TAPI Context with OamService information" parameters: - in: "body" name: "tapi.oam.context.OamContext.body-param" - description: "tapi.oam.OamContext to be added to list" + description: "tapi.oam.context.OamContext to be added to list" required: false schema: - $ref: "#/definitions/tapi.oam.OamContext" + $ref: "#/definitions/tapi.oam.context.OamContext" responses: 201: description: "Object created" @@ -5726,14 +6058,15 @@ paths: put: tags: - "tapi-oam" - description: "creates or updates tapi.oam.OamContext" + summary: "creates or updates tapi.oam.context.OamContext" + description: "Augments the base TAPI Context with OamService information" parameters: - in: "body" name: "tapi.oam.context.OamContext.body-param" - description: "tapi.oam.OamContext to be added or updated" + description: "tapi.oam.context.OamContext to be added or updated" required: false schema: - $ref: "#/definitions/tapi.oam.OamContext" + $ref: "#/definitions/tapi.oam.context.OamContext" responses: 201: description: "Object created" @@ -5744,7 +6077,8 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.oam.OamContext" + summary: "removes tapi.oam.context.OamContext" + description: "Augments the base TAPI Context with OamService information" parameters: [] responses: 400: @@ -5755,7 +6089,8 @@ paths: get: tags: - "tapi-oam" - description: "returns tapi.oam.oamcontext.Meg" + summary: "returns tapi.oam.oamcontext.Meg" + description: "none" parameters: - name: "uuid" in: "path" @@ -5773,7 +6108,11 @@ paths: get: tags: - "tapi-oam" - description: "returns tapi.oam.meg.Mep" + summary: "returns tapi.oam.meg.Mep" + description: "1. ME may have 0 MEPs (case of transit domains where at least\ + \ 1 MIP is present)\r\n 2. ME may have 1 MEP (case of edge\ + \ domaind, where the peer MEP is ouside the managed domain)\r\n \ + \ 3. ME may have 2 MEPs" parameters: - name: "uuid" in: "path" @@ -5796,7 +6135,10 @@ paths: get: tags: - "tapi-oam" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -5820,11 +6162,12 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/oam-context/meg={uuid}/mep={local-id}/odu-connection-end-point-spec/: + /data/context/oam-context/meg={uuid}/mep={local-id}/odu-mep-spec/: get: tags: - "tapi-odu" - description: "returns tapi.odu.OduConnectionEndPointSpec" + summary: "returns tapi.odu.OduMepSpec" + description: "none" parameters: - name: "uuid" in: "path" @@ -5838,16 +6181,17 @@ paths: type: "string" responses: 200: - description: "tapi.odu.OduConnectionEndPointSpec" + description: "tapi.odu.OduMepSpec" schema: - $ref: "#/definitions/tapi.odu.OduConnectionEndPointSpec" + $ref: "#/definitions/tapi.odu.OduMepSpec" 400: description: "Internal error" - /data/context/oam-context/meg={uuid}/mep={local-id}/odu-connection-end-point-spec/odu-common/: + /data/context/oam-context/meg={uuid}/mep={local-id}/odu-mep-spec/odu-defect/: get: tags: - "tapi-odu" - description: "returns tapi.odu.OduCommonPac" + summary: "returns tapi.odu.OduDefectPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -5861,16 +6205,17 @@ paths: type: "string" responses: 200: - description: "tapi.odu.OduCommonPac" + description: "tapi.odu.OduDefectPac" schema: - $ref: "#/definitions/tapi.odu.OduCommonPac" + $ref: "#/definitions/tapi.odu.OduDefectPac" 400: description: "Internal error" - /data/context/oam-context/meg={uuid}/mep={local-id}/odu-connection-end-point-spec/odu-ctp/: + /data/context/oam-context/meg={uuid}/mep={local-id}/odu-mep-spec/odu-mep/: get: tags: - "tapi-odu" - description: "returns tapi.odu.OduCtpPac" + summary: "returns tapi.odu.OduMepPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -5884,16 +6229,24 @@ paths: type: "string" responses: 200: - description: "tapi.odu.OduCtpPac" + description: "tapi.odu.OduMepPac" schema: - $ref: "#/definitions/tapi.odu.OduCtpPac" + $ref: "#/definitions/tapi.odu.OduMepPac" 400: description: "Internal error" - /data/context/oam-context/meg={uuid}/mep={local-id}/odu-connection-end-point-spec/odu-protection/: + /data/context/oam-context/meg={uuid}/mep={local-id}/odu-mep-spec/odu-mep/deg-thr/: get: tags: - "tapi-odu" - description: "returns tapi.odu.OduProtectionPac" + summary: "returns tapi.odu.DegThr" + description: "This attribute indicates the threshold level for declaring a performance\ + \ monitoring (PM) Second to be bad. The value of the threshold can be provisioned\ + \ in terms of number of errored blocks or in terms of percentage of errored\ + \ blocks. For percentage-based specification, in order to support provision\ + \ of less than 1%, the specification consists of two fields. The first field\ + \ indicates the granularity of percentage. For examples, in 1%, in 0.1%, or\ + \ in 0.01%, etc. The second field indicates the multiple of the granularity.\ + \ For number of errored block based, the value is a positive integer." parameters: - name: "uuid" in: "path" @@ -5907,16 +6260,17 @@ paths: type: "string" responses: 200: - description: "tapi.odu.OduProtectionPac" + description: "tapi.odu.DegThr" schema: - $ref: "#/definitions/tapi.odu.OduProtectionPac" + $ref: "#/definitions/tapi.odu.DegThr" 400: description: "Internal error" - /data/context/oam-context/meg={uuid}/mep={local-id}/odu-connection-end-point-spec/odu-term-and-adapter/: + /data/context/oam-context/meg={uuid}/mep={local-id}/odu-mep-spec/odu-ncm/: get: tags: - "tapi-odu" - description: "returns tapi.odu.OduTerminationAndClientAdaptationPac" + summary: "returns tapi.odu.OduNcmPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -5930,16 +6284,17 @@ paths: type: "string" responses: 200: - description: "tapi.odu.OduTerminationAndClientAdaptationPac" + description: "tapi.odu.OduNcmPac" schema: - $ref: "#/definitions/tapi.odu.OduTerminationAndClientAdaptationPac" + $ref: "#/definitions/tapi.odu.OduNcmPac" 400: description: "Internal error" - /data/context/oam-context/meg={uuid}/mep={local-id}/odu-connection-end-point-spec/odu-term-and-adapter/accepted-payload-type/: + /data/context/oam-context/meg={uuid}/mep={local-id}/odu-mep-spec/odu-pm/: get: tags: - "tapi-odu" - description: "returns tapi.odu.OduPayloadType" + summary: "returns tapi.odu.OduPmPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -5953,16 +6308,65 @@ paths: type: "string" responses: 200: - description: "tapi.odu.OduPayloadType" + description: "tapi.odu.OduPmPac" schema: - $ref: "#/definitions/tapi.odu.OduPayloadType" + $ref: "#/definitions/tapi.odu.OduPmPac" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mep={local-id}/odu-mep-spec/odu-pm/uas/: + get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.UasChoice" + description: "UnAvailable Second" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mep" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.UasChoice" + schema: + $ref: "#/definitions/tapi.odu.UasChoice" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mep={local-id}/odu-mep-spec/odu-tcm/: + get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.OduTcmMepPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mep" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.OduTcmMepPac" + schema: + $ref: "#/definitions/tapi.odu.OduTcmMepPac" 400: description: "Internal error" /data/context/oam-context/meg={uuid}/mip={local-id}/: get: tags: - "tapi-oam" - description: "returns tapi.oam.meg.Mip" + summary: "returns tapi.oam.meg.Mip" + description: "ME may 0, 1, or more MIPs" parameters: - name: "uuid" in: "path" @@ -5985,7 +6389,10 @@ paths: get: tags: - "tapi-oam" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -6013,7 +6420,8 @@ paths: get: tags: - "tapi-odu" - description: "returns tapi.odu.OduMipSpec" + summary: "returns tapi.odu.OduMipSpec" + description: "none" parameters: - name: "uuid" in: "path" @@ -6036,7 +6444,8 @@ paths: get: tags: - "tapi-odu" - description: "returns tapi.odu.OduDefectPac" + summary: "returns tapi.odu.OduDefectPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -6059,7 +6468,8 @@ paths: get: tags: - "tapi-odu" - description: "returns tapi.odu.OduMipPac" + summary: "returns tapi.odu.OduMipPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -6082,7 +6492,15 @@ paths: get: tags: - "tapi-odu" - description: "returns tapi.odu.DegThr" + summary: "returns tapi.odu.DegThr" + description: "This attribute indicates the threshold level for declaring a performance\ + \ monitoring (PM) Second to be bad. The value of the threshold can be provisioned\ + \ in terms of number of errored blocks or in terms of percentage of errored\ + \ blocks. For percentage-based specification, in order to support provision\ + \ of less than 1%, the specification consists of two fields. The first field\ + \ indicates the granularity of percentage. For examples, in 1%, in 0.1%, or\ + \ in 0.01%, etc. The second field indicates the multiple of the granularity.\ + \ For number of errored block based, the value is a positive integer." parameters: - name: "uuid" in: "path" @@ -6105,7 +6523,8 @@ paths: get: tags: - "tapi-odu" - description: "returns tapi.odu.OduNcmPac" + summary: "returns tapi.odu.OduNcmPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -6128,7 +6547,8 @@ paths: get: tags: - "tapi-odu" - description: "returns tapi.odu.OduPmPac" + summary: "returns tapi.odu.OduPmPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -6151,7 +6571,8 @@ paths: get: tags: - "tapi-odu" - description: "returns tapi.odu.UasChoice" + summary: "returns tapi.odu.UasChoice" + description: "UnAvailable Second" parameters: - name: "uuid" in: "path" @@ -6174,7 +6595,8 @@ paths: get: tags: - "tapi-odu" - description: "returns tapi.odu.OduTcmMipPac" + summary: "returns tapi.odu.OduTcmMipPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -6197,7 +6619,10 @@ paths: get: tags: - "tapi-oam" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -6216,11 +6641,31 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" + /data/context/oam-context/meg={uuid}/odu-meg-spec/: + get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.OduMegSpec" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.OduMegSpec" + schema: + $ref: "#/definitions/tapi.odu.OduMegSpec" + 400: + description: "Internal error" /data/context/oam-context/oam-job/: post: tags: - "tapi-oam" - description: "creates tapi.oam.OamJob" + summary: "creates tapi.oam.OamJob" + description: "none" parameters: - in: "body" name: "tapi.oam.OamJob.body-param" @@ -6239,7 +6684,8 @@ paths: get: tags: - "tapi-oam" - description: "returns tapi.oam.OamJob" + summary: "returns tapi.oam.OamJob" + description: "none" parameters: - name: "uuid" in: "path" @@ -6253,33 +6699,11 @@ paths: $ref: "#/definitions/tapi.oam.OamJob" 400: description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamJob" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamJob.body-param" - description: "tapi.oam.OamJob to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamJob" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-oam" - description: "creates or updates tapi.oam.OamJob" + summary: "creates or updates tapi.oam.OamJob" + description: "none" parameters: - name: "uuid" in: "path" @@ -6302,7 +6726,8 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.oam.OamJob" + summary: "removes tapi.oam.OamJob" + description: "none" parameters: - name: "uuid" in: "path" @@ -6314,286 +6739,312 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/name/: - post: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/: + get: tags: - "tapi-oam" - description: "creates tapi.common.NameAndValue" + summary: "returns tapi.oam.CurrentData" + description: "Granularity period of the CurrentData identifies the specific\ + \ CurrentData instance in the scope of this OamJob.\r\n For\ + \ example, typically at least\r\n one 15min and\r\n \ + \ one 24hr;\r\n optionally one additional configurable\ + \ (< 15min)" parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" responses: - 201: - description: "Object created" + 200: + description: "tapi.oam.CurrentData" + schema: + $ref: "#/definitions/tapi.oam.CurrentData" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-job={uuid}/name={value-name}/: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/elapsed-time/: get: tags: - "tapi-oam" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.TimeInterval" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of name" + description: "Id of current-data" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.common.TimeInterval" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.common.TimeInterval" 400: description: "Internal error" - post: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/elapsed-time/period={unit}/: + get: tags: - "tapi-oam" - description: "creates tapi.common.NameAndValue" + summary: "returns tapi.common.TimePeriod" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of name" + description: "Id of current-data" + required: true + type: "string" + - name: "unit" + in: "path" + description: "Id of period" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.common.TimePeriod" + schema: + $ref: "#/definitions/tapi.common.TimePeriod" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/: + get: tags: - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" + summary: "returns tapi.oam.HistoryData" + description: "in case of 24hr Current Data, at least 1 History Data.\r\n \ + \ In case of 15min Current Data, at least 16 History Data.\r\n\ + \ In case of <15min, the number of History Data shall be able\ + \ to cover a span of 4 hours." parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - name: "value-name" + - name: "local-id" in: "path" - description: "Id of name" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.oam.HistoryData" + schema: + $ref: "#/definitions/tapi.oam.HistoryData" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/name={value-name}/: + get: tags: - "tapi-oam" - description: "removes tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" - name: "value-name" in: "path" description: "Id of name" required: true type: "string" responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/oam-profile/: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/pm-data-pac/: get: tags: - "tapi-oam" - description: "returns tapi.oam.OamProfileRef" + summary: "returns tapi.oam.PmDataPac" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" responses: 200: - description: "tapi.oam.OamProfileRef" + description: "tapi.oam.PmDataPac" schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" + $ref: "#/definitions/tapi.oam.PmDataPac" 400: description: "Internal error" - post: + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/pm-data-pac/granularity-period/ + : get: tags: - "tapi-oam" - description: "creates tapi.oam.OamProfileRef" + summary: "returns tapi.common.TimePeriod" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - in: "body" - name: "tapi.oam.OamProfileRef.body-param" - description: "tapi.oam.OamProfileRef to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamProfileRef" - parameters: - - name: "uuid" + - name: "local-id" in: "path" - description: "Id of oam-job" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" required: true type: "string" - - in: "body" - name: "tapi.oam.OamProfileRef.body-param" - description: "tapi.oam.OamProfileRef to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" responses: - 201: - description: "Object created" + 200: + description: "tapi.common.TimePeriod" + schema: + $ref: "#/definitions/tapi.common.TimePeriod" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/name={value-name}/: + get: tags: - "tapi-oam" - description: "removes tapi.oam.OamProfileRef" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/oam-service-end-point/: - post: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/pm-data-pac/: + get: tags: - "tapi-oam" - description: "creates tapi.oam.OamServiceEndPointRef" + summary: "returns tapi.oam.PmDataPac" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - in: "body" - name: "tapi.oam.OamServiceEndPointRef.body-param" - description: "tapi.oam.OamServiceEndPointRef to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPointRef" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" responses: - 201: - description: "Object created" + 200: + description: "tapi.oam.PmDataPac" + schema: + $ref: "#/definitions/tapi.oam.PmDataPac" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-job={uuid}/oam-service-end-point={oam-service-uuid},{oam-service-end-point-local-id}/: + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/pm-data-pac/granularity-period/: get: tags: - "tapi-oam" - description: "returns tapi.oam.OamServiceEndPointRef" + summary: "returns tapi.common.TimePeriod" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - name: "oam-service-uuid" - in: "path" - description: "Id of oam-service-end-point" - required: true - type: "string" - - name: "oam-service-end-point-local-id" + - name: "local-id" in: "path" - description: "Id of oam-service-end-point" + description: "Id of current-data" required: true type: "string" responses: 200: - description: "tapi.oam.OamServiceEndPointRef" + description: "tapi.common.TimePeriod" schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPointRef" + $ref: "#/definitions/tapi.common.TimePeriod" 400: description: "Internal error" + /data/context/oam-context/oam-job={uuid}/name/: post: tags: - "tapi-oam" - description: "creates tapi.oam.OamServiceEndPointRef" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - name: "oam-service-uuid" - in: "path" - description: "Id of oam-service-end-point" - required: true - type: "string" - - name: "oam-service-end-point-local-id" - in: "path" - description: "Id of oam-service-end-point" - required: true - type: "string" - in: "body" - name: "tapi.oam.OamServiceEndPointRef.body-param" - description: "tapi.oam.OamServiceEndPointRef to be added to list" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPointRef" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -6601,32 +7052,56 @@ paths: description: "Internal error" 409: description: "Object already exists" - put: + /data/context/oam-context/oam-job={uuid}/name={value-name}/: + get: tags: - "tapi-oam" - description: "creates or updates tapi.oam.OamServiceEndPointRef" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - name: "oam-service-uuid" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" in: "path" - description: "Id of oam-service-end-point" + description: "Id of oam-job" required: true type: "string" - - name: "oam-service-end-point-local-id" + - name: "value-name" in: "path" - description: "Id of oam-service-end-point" + description: "Id of name" required: true type: "string" - in: "body" - name: "tapi.oam.OamServiceEndPointRef.body-param" - description: "tapi.oam.OamServiceEndPointRef to be added or updated" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPointRef" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -6637,21 +7112,19 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.oam.OamServiceEndPointRef" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - name: "oam-service-uuid" - in: "path" - description: "Id of oam-service-end-point" - required: true - type: "string" - - name: "oam-service-end-point-local-id" + - name: "value-name" in: "path" - description: "Id of oam-service-end-point" + description: "Id of name" required: true type: "string" responses: @@ -6659,225 +7132,209 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/: + /data/context/oam-context/oam-job={uuid}/oam-profile/: get: tags: - "tapi-oam" - description: "returns tapi.oam.PmCurrentData" + summary: "returns tapi.oam.OamProfileRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" responses: 200: - description: "tapi.oam.PmCurrentData" + description: "tapi.oam.OamProfileRef" schema: - $ref: "#/definitions/tapi.oam.PmCurrentData" + $ref: "#/definitions/tapi.oam.OamProfileRef" 400: description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/elapsed-time/: - get: + post: tags: - "tapi-oam" - description: "returns tapi.common.TimeInterval" + summary: "creates tapi.oam.OamProfileRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" + - in: "body" + name: "tapi.oam.OamProfileRef.body-param" + description: "tapi.oam.OamProfileRef to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamProfileRef" responses: - 200: - description: "tapi.common.TimeInterval" - schema: - $ref: "#/definitions/tapi.common.TimeInterval" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/elapsed-time/period={unit}/: - get: + 409: + description: "Object already exists" + put: tags: - "tapi-oam" - description: "returns tapi.common.TimePeriod" + summary: "creates or updates tapi.oam.OamProfileRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "unit" - in: "path" - description: "Id of period" - required: true - type: "string" + - in: "body" + name: "tapi.oam.OamProfileRef.body-param" + description: "tapi.oam.OamProfileRef to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamProfileRef" responses: - 200: - description: "tapi.common.TimePeriod" - schema: - $ref: "#/definitions/tapi.common.TimePeriod" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/granularity-period/: - get: + 204: + description: "Object modified" + delete: tags: - "tapi-oam" - description: "returns tapi.common.TimePeriod" + summary: "removes tapi.oam.OamProfileRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - name: "local-id" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-job={uuid}/oam-service-point/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.OamServicePointRef" + description: "none" + parameters: + - name: "uuid" in: "path" - description: "Id of pm-current-data" + description: "Id of oam-job" required: true type: "string" + - in: "body" + name: "tapi.oam.OamServicePointRef.body-param" + description: "tapi.oam.OamServicePointRef to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamServicePointRef" responses: - 200: - description: "tapi.common.TimePeriod" - schema: - $ref: "#/definitions/tapi.common.TimePeriod" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/name={value-name}/: + 409: + description: "Object already exists" + /data/context/oam-context/oam-job={uuid}/oam-service-point={oam-service-uuid},{oam-service-point-local-id}/: get: tags: - "tapi-oam" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.oam.OamServicePointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - name: "local-id" + - name: "oam-service-uuid" in: "path" - description: "Id of pm-current-data" + description: "Id of oam-service-point" required: true type: "string" - - name: "value-name" + - name: "oam-service-point-local-id" in: "path" - description: "Id of name" + description: "Id of oam-service-point" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.oam.OamServicePointRef" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.oam.OamServicePointRef" 400: description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/: - get: + put: tags: - "tapi-oam" - description: "returns tapi.oam.PmHistoryData" + summary: "creates or updates tapi.oam.OamServicePointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" - in: "path" - description: "Id of pm-history-data" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.PmHistoryData" - schema: - $ref: "#/definitions/tapi.oam.PmHistoryData" - 400: - description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/granularity-period/ - : get: - tags: - - "tapi-oam" - description: "returns tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" + - name: "oam-service-uuid" in: "path" - description: "Id of pm-current-data" + description: "Id of oam-service-point" required: true type: "string" - - name: "pm-history-data-local-id" + - name: "oam-service-point-local-id" in: "path" - description: "Id of pm-history-data" + description: "Id of oam-service-point" required: true type: "string" + - in: "body" + name: "tapi.oam.OamServicePointRef.body-param" + description: "tapi.oam.OamServicePointRef to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamServicePointRef" responses: - 200: - description: "tapi.common.TimePeriod" - schema: - $ref: "#/definitions/tapi.common.TimePeriod" + 201: + description: "Object created" 400: description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/name={value-name}/ - : get: + 204: + description: "Object modified" + delete: tags: - "tapi-oam" - description: "returns tapi.common.NameAndValue" + summary: "removes tapi.oam.OamServicePointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-job" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" + - name: "oam-service-uuid" in: "path" - description: "Id of pm-history-data" + description: "Id of oam-service-point" required: true type: "string" - - name: "value-name" + - name: "oam-service-point-local-id" in: "path" - description: "Id of name" + description: "Id of oam-service-point" required: true type: "string" responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" + 204: + description: "Object deleted" /data/context/oam-context/oam-job={uuid}/schedule/: get: tags: - "tapi-oam" - description: "returns tapi.common.TimeRange" + summary: "returns tapi.common.TimeRange" + description: "none" parameters: - name: "uuid" in: "path" @@ -6894,7 +7351,8 @@ paths: post: tags: - "tapi-oam" - description: "creates tapi.common.TimeRange" + summary: "creates tapi.common.TimeRange" + description: "none" parameters: - name: "uuid" in: "path" @@ -6917,7 +7375,8 @@ paths: put: tags: - "tapi-oam" - description: "creates or updates tapi.common.TimeRange" + summary: "creates or updates tapi.common.TimeRange" + description: "none" parameters: - name: "uuid" in: "path" @@ -6940,7 +7399,8 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.common.TimeRange" + summary: "removes tapi.common.TimeRange" + description: "none" parameters: - name: "uuid" in: "path" @@ -6956,7 +7416,8 @@ paths: post: tags: - "tapi-oam" - description: "creates tapi.oam.OamProfile" + summary: "creates tapi.oam.OamProfile" + description: "none" parameters: - in: "body" name: "tapi.oam.OamProfile.body-param" @@ -6975,7 +7436,8 @@ paths: get: tags: - "tapi-oam" - description: "returns tapi.oam.OamProfile" + summary: "returns tapi.oam.OamProfile" + description: "none" parameters: - name: "uuid" in: "path" @@ -6989,33 +7451,11 @@ paths: $ref: "#/definitions/tapi.oam.OamProfile" 400: description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamProfile.body-param" - description: "tapi.oam.OamProfile to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-oam" - description: "creates or updates tapi.oam.OamProfile" + summary: "creates or updates tapi.oam.OamProfile" + description: "none" parameters: - name: "uuid" in: "path" @@ -7038,7 +7478,8 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.oam.OamProfile" + summary: "removes tapi.oam.OamProfile" + description: "none" parameters: - name: "uuid" in: "path" @@ -7054,7 +7495,10 @@ paths: post: tags: - "tapi-oam" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -7078,7 +7522,10 @@ paths: get: tags: - "tapi-oam" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -7097,38 +7544,13 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -7156,7 +7578,10 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -7173,11 +7598,12 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-bin-data/: + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data/: post: tags: - "tapi-oam" - description: "creates tapi.oam.PmBinData" + summary: "creates tapi.oam.PmThresholdData" + description: "none" parameters: - name: "uuid" in: "path" @@ -7185,11 +7611,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.oam.PmBinData.body-param" - description: "tapi.oam.PmBinData to be added to list" + name: "tapi.oam.PmThresholdData.body-param" + description: "tapi.oam.PmThresholdData to be added to list" required: false schema: - $ref: "#/definitions/tapi.oam.PmBinData" + $ref: "#/definitions/tapi.oam.PmThresholdData" responses: 201: description: "Object created" @@ -7197,11 +7623,12 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/pm-bin-data={local-id}/: + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/: get: tags: - "tapi-oam" - description: "returns tapi.oam.PmBinData" + summary: "returns tapi.oam.PmThresholdData" + description: "none" parameters: - name: "uuid" in: "path" @@ -7210,48 +7637,21 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-bin-data" + description: "Id of pm-threshold-data" required: true type: "string" responses: 200: - description: "tapi.oam.PmBinData" + description: "tapi.oam.PmThresholdData" schema: - $ref: "#/definitions/tapi.oam.PmBinData" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.PmBinData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - in: "body" - name: "tapi.oam.PmBinData.body-param" - description: "tapi.oam.PmBinData to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.PmBinData" - responses: - 201: - description: "Object created" + $ref: "#/definitions/tapi.oam.PmThresholdData" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-oam" - description: "creates or updates tapi.oam.PmBinData" + summary: "creates or updates tapi.oam.PmThresholdData" + description: "none" parameters: - name: "uuid" in: "path" @@ -7260,15 +7660,15 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-bin-data" + description: "Id of pm-threshold-data" required: true type: "string" - in: "body" - name: "tapi.oam.PmBinData.body-param" - description: "tapi.oam.PmBinData to be added or updated" + name: "tapi.oam.PmThresholdData.body-param" + description: "tapi.oam.PmThresholdData to be added or updated" required: false schema: - $ref: "#/definitions/tapi.oam.PmBinData" + $ref: "#/definitions/tapi.oam.PmThresholdData" responses: 201: description: "Object created" @@ -7279,7 +7679,8 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.oam.PmBinData" + summary: "removes tapi.oam.PmThresholdData" + description: "none" parameters: - name: "uuid" in: "path" @@ -7288,7 +7689,7 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-bin-data" + description: "Id of pm-threshold-data" required: true type: "string" responses: @@ -7296,11 +7697,12 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-bin-data={local-id}/granularity-period/: + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/granularity-period/: get: tags: - "tapi-oam" - description: "returns tapi.common.TimePeriod" + summary: "returns tapi.common.TimePeriod" + description: "none" parameters: - name: "uuid" in: "path" @@ -7309,7 +7711,7 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-bin-data" + description: "Id of pm-threshold-data" required: true type: "string" responses: @@ -7322,7 +7724,8 @@ paths: post: tags: - "tapi-oam" - description: "creates tapi.common.TimePeriod" + summary: "creates tapi.common.TimePeriod" + description: "none" parameters: - name: "uuid" in: "path" @@ -7331,7 +7734,7 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-bin-data" + description: "Id of pm-threshold-data" required: true type: "string" - in: "body" @@ -7350,7 +7753,8 @@ paths: put: tags: - "tapi-oam" - description: "creates or updates tapi.common.TimePeriod" + summary: "creates or updates tapi.common.TimePeriod" + description: "none" parameters: - name: "uuid" in: "path" @@ -7359,7 +7763,7 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-bin-data" + description: "Id of pm-threshold-data" required: true type: "string" - in: "body" @@ -7378,7 +7782,8 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.common.TimePeriod" + summary: "removes tapi.common.TimePeriod" + description: "none" parameters: - name: "uuid" in: "path" @@ -7387,7 +7792,7 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-bin-data" + description: "Id of pm-threshold-data" required: true type: "string" responses: @@ -7395,11 +7800,14 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-bin-data={local-id}/name/: + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/name/: post: tags: - "tapi-oam" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -7408,7 +7816,7 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-bin-data" + description: "Id of pm-threshold-data" required: true type: "string" - in: "body" @@ -7424,11 +7832,14 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/pm-bin-data={local-id}/name={value-name}/: + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/name={value-name}/: get: tags: - "tapi-oam" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -7437,7 +7848,7 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-bin-data" + description: "Id of pm-threshold-data" required: true type: "string" - name: "value-name" @@ -7452,43 +7863,13 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -7497,7 +7878,7 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-bin-data" + description: "Id of pm-threshold-data" required: true type: "string" - name: "value-name" @@ -7521,7 +7902,10 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -7530,7 +7914,7 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of pm-bin-data" + description: "Id of pm-threshold-data" required: true type: "string" - name: "value-name" @@ -7543,23 +7927,29 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data/: + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/threshold-parameter/: post: tags: - "tapi-oam" - description: "creates tapi.oam.PmThresholdData" + summary: "creates tapi.oam.ThresholdParameter" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-profile" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" - in: "body" - name: "tapi.oam.PmThresholdData.body-param" - description: "tapi.oam.PmThresholdData to be added to list" + name: "tapi.oam.ThresholdParameter.body-param" + description: "tapi.oam.ThresholdParameter to be added to list" required: false schema: - $ref: "#/definitions/tapi.oam.PmThresholdData" + $ref: "#/definitions/tapi.oam.ThresholdParameter" responses: 201: description: "Object created" @@ -7567,11 +7957,12 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/: - get: + ? /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/threshold-parameter={pm-parameter-name},{threshold-location}/ + : get: tags: - "tapi-oam" - description: "returns tapi.oam.PmThresholdData" + summary: "returns tapi.oam.ThresholdParameter" + description: "none" parameters: - name: "uuid" in: "path" @@ -7583,17 +7974,28 @@ paths: description: "Id of pm-threshold-data" required: true type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" responses: 200: - description: "tapi.oam.PmThresholdData" + description: "tapi.oam.ThresholdParameter" schema: - $ref: "#/definitions/tapi.oam.PmThresholdData" + $ref: "#/definitions/tapi.oam.ThresholdParameter" 400: description: "Internal error" - post: + put: tags: - "tapi-oam" - description: "creates tapi.oam.PmThresholdData" + summary: "creates or updates tapi.oam.ThresholdParameter" + description: "none" parameters: - name: "uuid" in: "path" @@ -7605,40 +8007,22 @@ paths: description: "Id of pm-threshold-data" required: true type: "string" - - in: "body" - name: "tapi.oam.PmThresholdData.body-param" - description: "tapi.oam.PmThresholdData to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.PmThresholdData" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.PmThresholdData" - parameters: - - name: "uuid" + - name: "pm-parameter-name" in: "path" - description: "Id of oam-profile" + description: "Id of threshold-parameter" required: true type: "string" - - name: "local-id" + - name: "threshold-location" in: "path" - description: "Id of pm-threshold-data" + description: "Id of threshold-parameter" required: true type: "string" - in: "body" - name: "tapi.oam.PmThresholdData.body-param" - description: "tapi.oam.PmThresholdData to be added or updated" + name: "tapi.oam.ThresholdParameter.body-param" + description: "tapi.oam.ThresholdParameter to be added or updated" required: false schema: - $ref: "#/definitions/tapi.oam.PmThresholdData" + $ref: "#/definitions/tapi.oam.ThresholdParameter" responses: 201: description: "Object created" @@ -7649,7 +8033,8 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.oam.PmThresholdData" + summary: "removes tapi.oam.ThresholdParameter" + description: "none" parameters: - name: "uuid" in: "path" @@ -7661,16 +8046,27 @@ paths: description: "Id of pm-threshold-data" required: true type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/granularity-period/: - get: + ? /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/threshold-parameter={pm-parameter-name},{threshold-location}/pm-parameter-above-thrs/ + : get: tags: - "tapi-oam" - description: "returns tapi.common.TimePeriod" + summary: "returns tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -7682,17 +8078,28 @@ paths: description: "Id of pm-threshold-data" required: true type: "string" - responses: - 200: - description: "tapi.common.TimePeriod" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.PmParameterValue" schema: - $ref: "#/definitions/tapi.common.TimePeriod" + $ref: "#/definitions/tapi.oam.PmParameterValue" 400: description: "Internal error" post: tags: - "tapi-oam" - description: "creates tapi.common.TimePeriod" + summary: "creates tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -7704,12 +8111,22 @@ paths: description: "Id of pm-threshold-data" required: true type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" - in: "body" - name: "tapi.common.TimePeriod.body-param" - description: "tapi.common.TimePeriod to be added to list" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.TimePeriod" + $ref: "#/definitions/tapi.oam.PmParameterValue" responses: 201: description: "Object created" @@ -7720,7 +8137,8 @@ paths: put: tags: - "tapi-oam" - description: "creates or updates tapi.common.TimePeriod" + summary: "creates or updates tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -7732,12 +8150,22 @@ paths: description: "Id of pm-threshold-data" required: true type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" - in: "body" - name: "tapi.common.TimePeriod.body-param" - description: "tapi.common.TimePeriod to be added or updated" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.TimePeriod" + $ref: "#/definitions/tapi.oam.PmParameterValue" responses: 201: description: "Object created" @@ -7748,7 +8176,8 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.common.TimePeriod" + summary: "removes tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -7760,16 +8189,60 @@ paths: description: "Id of pm-threshold-data" required: true type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/name/: + ? /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/threshold-parameter={pm-parameter-name},{threshold-location}/pm-parameter-below-thrs/ + : get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.PmParameterValue" + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + 400: + description: "Internal error" post: tags: - "tapi-oam" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -7781,12 +8254,22 @@ paths: description: "Id of pm-threshold-data" required: true type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.oam.PmParameterValue" responses: 201: description: "Object created" @@ -7794,11 +8277,11 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/name={value-name}/: - get: + put: tags: - "tapi-oam" - description: "returns tapi.common.NameAndValue" + summary: "creates or updates tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -7810,22 +8293,99 @@ paths: description: "Id of pm-threshold-data" required: true type: "string" - - name: "value-name" + - name: "pm-parameter-name" in: "path" - description: "Id of name" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - in: "body" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/threshold-parameter={pm-parameter-name},{threshold-location}/pm-parameter-clear-thrs/ + : get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.oam.PmParameterValue" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.oam.PmParameterValue" 400: description: "Internal error" post: tags: - "tapi-oam" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -7837,17 +8397,22 @@ paths: description: "Id of pm-threshold-data" required: true type: "string" - - name: "value-name" + - name: "pm-parameter-name" in: "path" - description: "Id of name" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.oam.PmParameterValue" responses: 201: description: "Object created" @@ -7858,7 +8423,8 @@ paths: put: tags: - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" + summary: "creates or updates tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -7870,17 +8436,22 @@ paths: description: "Id of pm-threshold-data" required: true type: "string" - - name: "value-name" + - name: "pm-parameter-name" in: "path" - description: "Id of name" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.oam.PmParameterValue" responses: 201: description: "Object created" @@ -7891,7 +8462,8 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.oam.PmParameterValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -7903,9 +8475,14 @@ paths: description: "Id of pm-threshold-data" required: true type: "string" - - name: "value-name" + - name: "pm-parameter-name" in: "path" - description: "Id of name" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" required: true type: "string" responses: @@ -7917,7 +8494,8 @@ paths: post: tags: - "tapi-oam" - description: "creates tapi.oam.OamService" + summary: "creates tapi.oam.OamService" + description: "none" parameters: - in: "body" name: "tapi.oam.OamService.body-param" @@ -7936,7 +8514,8 @@ paths: get: tags: - "tapi-oam" - description: "returns tapi.oam.OamService" + summary: "returns tapi.oam.OamService" + description: "none" parameters: - name: "uuid" in: "path" @@ -7950,10 +8529,11 @@ paths: $ref: "#/definitions/tapi.oam.OamService" 400: description: "Internal error" - post: + put: tags: - "tapi-oam" - description: "creates tapi.oam.OamService" + summary: "creates or updates tapi.oam.OamService" + description: "none" parameters: - name: "uuid" in: "path" @@ -7962,7 +8542,7 @@ paths: type: "string" - in: "body" name: "tapi.oam.OamService.body-param" - description: "tapi.oam.OamService to be added to list" + description: "tapi.oam.OamService to be added or updated" required: false schema: $ref: "#/definitions/tapi.oam.OamService" @@ -7971,35 +8551,30 @@ paths: description: "Object created" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + 204: + description: "Object modified" + delete: tags: - "tapi-oam" - description: "creates or updates tapi.oam.OamService" + summary: "removes tapi.oam.OamService" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-service" required: true type: "string" - - in: "body" - name: "tapi.oam.OamService.body-param" - description: "tapi.oam.OamService to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamService" responses: - 201: - description: "Object created" 400: description: "Internal error" 204: - description: "Object modified" - delete: + description: "Object deleted" + /data/context/oam-context/oam-service={uuid}/meg/: + get: tags: - "tapi-oam" - description: "removes tapi.oam.OamService" + summary: "returns tapi.oam.MegRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -8007,15 +8582,20 @@ paths: required: true type: "string" responses: + 200: + description: "tapi.oam.MegRef" + schema: + $ref: "#/definitions/tapi.oam.MegRef" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/end-point/: + /data/context/oam-context/oam-service={uuid}/name/: post: tags: - "tapi-oam" - description: "creates tapi.oam.OamServiceEndPoint" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -8023,11 +8603,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.oam.OamServiceEndPoint.body-param" - description: "tapi.oam.OamServiceEndPoint to be added to list" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -8035,110 +8615,117 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/: + /data/context/oam-context/oam-service={uuid}/name={value-name}/: get: tags: - "tapi-oam" - description: "returns tapi.oam.OamServiceEndPoint" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of oam-service" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of end-point" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.oam.OamServiceEndPoint" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: + put: tags: - "tapi-oam" - description: "creates tapi.oam.OamServiceEndPoint" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of oam-service" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of end-point" + description: "Id of name" required: true type: "string" - in: "body" - name: "tapi.oam.OamServiceEndPoint.body-param" - description: "tapi.oam.OamServiceEndPoint to be added to list" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + 204: + description: "Object modified" + delete: tags: - "tapi-oam" - description: "creates or updates tapi.oam.OamServiceEndPoint" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of oam-service" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of end-point" + description: "Id of name" required: true type: "string" - - in: "body" - name: "tapi.oam.OamServiceEndPoint.body-param" - description: "tapi.oam.OamServiceEndPoint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" responses: - 201: - description: "Object created" 400: description: "Internal error" 204: - description: "Object modified" - delete: + description: "Object deleted" + /data/context/oam-context/oam-service={uuid}/oam-service-point/: + post: tags: - "tapi-oam" - description: "removes tapi.oam.OamServiceEndPoint" + summary: "creates tapi.oam.OamServicePoint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of oam-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" + - in: "body" + name: "tapi.oam.OamServicePoint.body-param" + description: "tapi.oam.OamServicePoint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamServicePoint" responses: + 201: + description: "Object created" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/connectivity-service-end-point/: + 409: + description: "Object already exists" + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/: get: tags: - "tapi-oam" - description: "returns tapi.connectivity.ConnectivityServiceEndPointRef" + summary: "returns tapi.oam.OamServicePoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -8147,12 +8734,86 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of oam-service-point" required: true type: "string" responses: 200: - description: "tapi.connectivity.ConnectivityServiceEndPointRef" + description: "tapi.oam.OamServicePoint" + schema: + $ref: "#/definitions/tapi.oam.OamServicePoint" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.OamServicePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - in: "body" + name: "tapi.oam.OamServicePoint.body-param" + description: "tapi.oam.OamServicePoint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamServicePoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.OamServicePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/connectivity-service-end-point/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 200: + description: "tapi.connectivity.ConnectivityServiceEndPointRef" schema: $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" 400: @@ -8160,7 +8821,8 @@ paths: post: tags: - "tapi-oam" - description: "creates tapi.connectivity.ConnectivityServiceEndPointRef" + summary: "creates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -8169,7 +8831,7 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of oam-service-point" required: true type: "string" - in: "body" @@ -8189,7 +8851,8 @@ paths: put: tags: - "tapi-oam" - description: "creates or updates tapi.connectivity.ConnectivityServiceEndPointRef" + summary: "creates or updates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -8198,7 +8861,7 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of oam-service-point" required: true type: "string" - in: "body" @@ -8218,7 +8881,8 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.connectivity.ConnectivityServiceEndPointRef" + summary: "removes tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -8227,7 +8891,7 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of oam-service-point" required: true type: "string" responses: @@ -8235,11 +8899,12 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/mep/: + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/mep/: get: tags: - "tapi-oam" - description: "returns tapi.oam.MepRef" + summary: "returns tapi.oam.MepRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -8248,7 +8913,7 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of oam-service-point" required: true type: "string" responses: @@ -8258,11 +8923,12 @@ paths: $ref: "#/definitions/tapi.oam.MepRef" 400: description: "Internal error" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/mip/: + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/mip/: get: tags: - "tapi-oam" - description: "returns tapi.oam.MipRef" + summary: "returns tapi.oam.MipRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -8271,7 +8937,7 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of oam-service-point" required: true type: "string" responses: @@ -8281,11 +8947,14 @@ paths: $ref: "#/definitions/tapi.oam.MipRef" 400: description: "Internal error" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/name/: + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/name/: post: tags: - "tapi-oam" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -8294,7 +8963,7 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of oam-service-point" required: true type: "string" - in: "body" @@ -8310,11 +8979,14 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/name={value-name}/: + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/name={value-name}/: get: tags: - "tapi-oam" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -8323,7 +8995,7 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of oam-service-point" required: true type: "string" - name: "value-name" @@ -8338,43 +9010,13 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -8383,7 +9025,7 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of oam-service-point" required: true type: "string" - name: "value-name" @@ -8407,7 +9049,10 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -8416,7 +9061,7 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of oam-service-point" required: true type: "string" - name: "value-name" @@ -8429,11 +9074,12 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/service-interface-point/: + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/service-interface-point/: get: tags: - "tapi-oam" - description: "returns tapi.common.ServiceInterfacePointRef" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -8442,7 +9088,7 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of oam-service-point" required: true type: "string" responses: @@ -8455,7 +9101,8 @@ paths: post: tags: - "tapi-oam" - description: "creates tapi.common.ServiceInterfacePointRef" + summary: "creates tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -8464,7 +9111,7 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of oam-service-point" required: true type: "string" - in: "body" @@ -8483,7 +9130,8 @@ paths: put: tags: - "tapi-oam" - description: "creates or updates tapi.common.ServiceInterfacePointRef" + summary: "creates or updates tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -8492,7 +9140,7 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of oam-service-point" required: true type: "string" - in: "body" @@ -8511,7 +9159,8 @@ paths: delete: tags: - "tapi-oam" - description: "removes tapi.common.ServiceInterfacePointRef" + summary: "removes tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -8520,7 +9169,7 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of end-point" + description: "Id of oam-service-point" required: true type: "string" responses: @@ -8528,41 +9177,33 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/meg/: + /data/context/path-computation-context/: get: tags: - - "tapi-oam" - description: "returns tapi.oam.MegRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" + - "tapi-path-computation" + summary: "returns tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" + parameters: [] responses: 200: - description: "tapi.oam.MegRef" + description: "tapi.path.computation.PathComputationContext" schema: - $ref: "#/definitions/tapi.oam.MegRef" + $ref: "#/definitions/tapi.path.computation.PathComputationContext" 400: description: "Internal error" - /data/context/oam-context/oam-service={uuid}/name/: post: tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" + - "tapi-path-computation" + summary: "creates tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.path.computation.PathComputationContext.body-param" + description: "tapi.path.computation.PathComputationContext to be added to\ + \ list" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.path.computation.PathComputationContext" responses: 201: description: "Object created" @@ -8570,50 +9211,51 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/oam-context/oam-service={uuid}/name={value-name}/: - get: + put: tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" + - "tapi-path-computation" + summary: "creates or updates tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" + - in: "body" + name: "tapi.path.computation.PathComputationContext.body-param" + description: "tapi.path.computation.PathComputationContext to be added or\ + \ updated" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.PathComputationContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" + parameters: [] responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service/: post: tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" + - "tapi-path-computation" + summary: "creates tapi.path.computation.PathComputationService" + description: "none" parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.path.computation.PathComputationService.body-param" + description: "tapi.path.computation.PathComputationService to be added to\ + \ list" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.path.computation.PathComputationService" responses: 201: description: "Object created" @@ -8621,27 +9263,43 @@ paths: description: "Internal error" 409: description: "Object already exists" - put: + /data/context/path-computation-context/path-comp-service={uuid}/: + get: tags: - - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" + - "tapi-path-computation" + summary: "returns tapi.path.computation.PathComputationService" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" - - name: "value-name" + responses: + 200: + description: "tapi.path.computation.PathComputationService" + schema: + $ref: "#/definitions/tapi.path.computation.PathComputationService" + 400: + description: "Internal error" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.path.computation.PathComputationService" + description: "none" + parameters: + - name: "uuid" in: "path" - description: "Id of name" + description: "Id of path-comp-service" required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" + name: "tapi.path.computation.PathComputationService.body-param" + description: "tapi.path.computation.PathComputationService to be added or\ + \ updated" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.path.computation.PathComputationService" responses: 201: description: "Object created" @@ -8651,17 +9309,13 @@ paths: description: "Object modified" delete: tags: - - "tapi-oam" - description: "removes tapi.common.NameAndValue" + - "tapi-path-computation" + summary: "removes tapi.path.computation.PathComputationService" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of path-comp-service" required: true type: "string" responses: @@ -8669,40 +9323,24 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/oam-profile/: - get: + /data/context/path-computation-context/path-comp-service={uuid}/end-point/: + post: tags: - - "tapi-oam" - description: "returns tapi.oam.OamProfileRef" + - "tapi-path-computation" + summary: "creates tapi.path.computation.PathServiceEndPoint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-service" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.OamProfileRef" - schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamProfileRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" - in: "body" - name: "tapi.oam.OamProfileRef.body-param" - description: "tapi.oam.OamProfileRef to be added to list" + name: "tapi.path.computation.PathServiceEndPoint.body-param" + description: "tapi.path.computation.PathServiceEndPoint to be added to list" required: false schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" + $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" responses: 201: description: "Object created" @@ -8710,184 +9348,52 @@ paths: description: "Internal error" 409: description: "Object already exists" - put: + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/: + get: tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamProfileRef" + - "tapi-path-computation" + summary: "returns tapi.path.computation.PathServiceEndPoint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of oam-service" + description: "Id of path-comp-service" required: true type: "string" - - in: "body" - name: "tapi.oam.OamProfileRef.body-param" - description: "tapi.oam.OamProfileRef to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.OamProfileRef" - parameters: - - name: "uuid" + - name: "local-id" in: "path" - description: "Id of oam-service" + description: "Id of end-point" required: true type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathComputationContext" - parameters: [] responses: 200: - description: "tapi.path.computation.PathComputationContext" + description: "tapi.path.computation.PathServiceEndPoint" schema: - $ref: "#/definitions/tapi.path.computation.PathComputationContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathComputationContext" - parameters: - - in: "body" - name: "tapi.path.computation.PathComputationContext.body-param" - description: "tapi.path.computation.PathComputationContext to be added to\ - \ list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationContext" - responses: - 201: - description: "Object created" + $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathComputationContext" - parameters: - - in: "body" - name: "tapi.path.computation.PathComputationContext.body-param" - description: "tapi.path.computation.PathComputationContext to be added or\ - \ updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.PathComputationContext" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathComputationService" - parameters: - - in: "body" - name: "tapi.path.computation.PathComputationService.body-param" - description: "tapi.path.computation.PathComputationService to be added to\ - \ list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathComputationService" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathComputationService" - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationService" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathComputationService" + summary: "creates or updates tapi.path.computation.PathServiceEndPoint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - in: "body" - name: "tapi.path.computation.PathComputationService.body-param" - description: "tapi.path.computation.PathComputationService to be added to\ - \ list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathComputationService" - parameters: - - name: "uuid" + - name: "local-id" in: "path" - description: "Id of path-comp-service" + description: "Id of end-point" required: true type: "string" - in: "body" - name: "tapi.path.computation.PathComputationService.body-param" - description: "tapi.path.computation.PathComputationService to be added or\ - \ updated" + name: "tapi.path.computation.PathServiceEndPoint.body-param" + description: "tapi.path.computation.PathServiceEndPoint to be added or updated" required: false schema: - $ref: "#/definitions/tapi.path.computation.PathComputationService" + $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" responses: 201: description: "Object created" @@ -8898,47 +9404,30 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.path.computation.PathComputationService" + summary: "removes tapi.path.computation.PathServiceEndPoint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathServiceEndPoint" - parameters: - - name: "uuid" + - name: "local-id" in: "path" - description: "Id of path-comp-service" + description: "Id of end-point" required: true type: "string" - - in: "body" - name: "tapi.path.computation.PathServiceEndPoint.body-param" - description: "tapi.path.computation.PathServiceEndPoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" responses: - 201: - description: "Object created" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/: + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/: get: tags: - "tapi-path-computation" - description: "returns tapi.path.computation.PathServiceEndPoint" + summary: "returns tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" @@ -8952,15 +9441,16 @@ paths: type: "string" responses: 200: - description: "tapi.path.computation.PathServiceEndPoint" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" post: tags: - "tapi-path-computation" - description: "creates tapi.path.computation.PathServiceEndPoint" + summary: "creates tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" @@ -8973,11 +9463,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.path.computation.PathServiceEndPoint.body-param" - description: "tapi.path.computation.PathServiceEndPoint to be added to list" + name: "tapi.common.Capacity.body-param" + description: "tapi.common.Capacity to be added to list" required: false schema: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + $ref: "#/definitions/tapi.common.Capacity" responses: 201: description: "Object created" @@ -8988,7 +9478,8 @@ paths: put: tags: - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathServiceEndPoint" + summary: "creates or updates tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" @@ -9001,11 +9492,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.path.computation.PathServiceEndPoint.body-param" - description: "tapi.path.computation.PathServiceEndPoint to be added or updated" + name: "tapi.common.Capacity.body-param" + description: "tapi.common.Capacity to be added or updated" required: false schema: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + $ref: "#/definitions/tapi.common.Capacity" responses: 201: description: "Object created" @@ -9016,7 +9507,8 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.path.computation.PathServiceEndPoint" + summary: "removes tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" @@ -9033,11 +9525,13 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/: + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/total-size/: get: tags: - "tapi-path-computation" - description: "returns tapi.common.Capacity" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -9051,15 +9545,17 @@ paths: type: "string" responses: 200: - description: "tapi.common.Capacity" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" post: tags: - "tapi-path-computation" - description: "creates tapi.common.Capacity" + summary: "creates tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -9072,11 +9568,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.Capacity.body-param" - description: "tapi.common.Capacity to be added to list" + name: "tapi.common.CapacityValue.body-param" + description: "tapi.common.CapacityValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.common.CapacityValue" responses: 201: description: "Object created" @@ -9087,7 +9583,9 @@ paths: put: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.Capacity" + summary: "creates or updates tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -9100,11 +9598,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.Capacity.body-param" - description: "tapi.common.Capacity to be added or updated" + name: "tapi.common.CapacityValue.body-param" + description: "tapi.common.CapacityValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.common.CapacityValue" responses: 201: description: "Object created" @@ -9115,7 +9613,9 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.common.Capacity" + summary: "removes tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -9132,11 +9632,14 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/: - get: + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/name/: + post: tags: - "tapi-path-computation" - description: "returns tapi.common.BandwidthProfile" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -9148,17 +9651,27 @@ paths: description: "Id of end-point" required: true type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/name={value-name}/: + get: tags: - "tapi-path-computation" - description: "creates tapi.common.BandwidthProfile" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -9170,23 +9683,25 @@ paths: description: "Id of end-point" required: true type: "string" - - in: "body" - name: "tapi.common.BandwidthProfile.body-param" - description: "tapi.common.BandwidthProfile to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" responses: - 201: - description: "Object created" + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.BandwidthProfile" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -9198,12 +9713,17 @@ paths: description: "Id of end-point" required: true type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" - in: "body" - name: "tapi.common.BandwidthProfile.body-param" - description: "tapi.common.BandwidthProfile to be added or updated" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -9214,7 +9734,10 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.common.BandwidthProfile" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -9226,16 +9749,22 @@ paths: description: "Id of end-point" required: true type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-burst-size/ - : get: + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/service-interface-point/: + get: tags: - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -9249,15 +9778,16 @@ paths: type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.ServiceInterfacePointRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" 400: description: "Internal error" post: tags: - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" + summary: "creates tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -9270,11 +9800,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.common.ServiceInterfacePointRef.body-param" + description: "tapi.common.ServiceInterfacePointRef to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" responses: 201: description: "Object created" @@ -9285,7 +9815,8 @@ paths: put: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -9298,11 +9829,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.common.ServiceInterfacePointRef.body-param" + description: "tapi.common.ServiceInterfacePointRef to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" responses: 201: description: "Object created" @@ -9313,7 +9844,8 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -9330,78 +9862,83 @@ paths: description: "Internal error" 204: description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-information-rate/ - : get: + /data/context/path-computation-context/path-comp-service={uuid}/name/: + post: tags: - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/name={value-name}/: + get: tags: - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of end-point" + description: "Id of name" required: true type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of end-point" + description: "Id of name" required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -9412,16 +9949,19 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of end-point" + description: "Id of name" required: true type: "string" responses: @@ -9429,50 +9969,42 @@ paths: description: "Internal error" 204: description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-burst-size/ - : get: + /data/context/path-computation-context/path-comp-service={uuid}/objective-function/: + get: tags: - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.path.computation.PathObjectiveFunction" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.path.computation.PathObjectiveFunction" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" 400: description: "Internal error" post: tags: - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" + summary: "creates tapi.path.computation.PathObjectiveFunction" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.path.computation.PathObjectiveFunction.body-param" + description: "tapi.path.computation.PathObjectiveFunction to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" responses: 201: description: "Object created" @@ -9483,24 +10015,20 @@ paths: put: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.path.computation.PathObjectiveFunction" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.path.computation.PathObjectiveFunction.body-param" + description: "tapi.path.computation.PathObjectiveFunction to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" responses: 201: description: "Object created" @@ -9511,95 +10039,96 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.path.computation.PathObjectiveFunction" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-information-rate/ - : get: + /data/context/path-computation-context/path-comp-service={uuid}/objective-function/name/: + post: tags: - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/objective-function/name={value-name}/: + get: tags: - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of end-point" + description: "Id of name" required: true type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" responses: - 201: - description: "Object created" + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of end-point" + description: "Id of name" required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -9610,16 +10139,19 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of end-point" + description: "Id of name" required: true type: "string" responses: @@ -9627,50 +10159,43 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/total-size/: + /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/: get: tags: - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.path.computation.PathOptimizationConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.path.computation.PathOptimizationConstraint" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" 400: description: "Internal error" post: tags: - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" + summary: "creates tapi.path.computation.PathOptimizationConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.path.computation.PathOptimizationConstraint.body-param" + description: "tapi.path.computation.PathOptimizationConstraint to be added\ + \ to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" responses: 201: description: "Object created" @@ -9681,24 +10206,21 @@ paths: put: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.path.computation.PathOptimizationConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.path.computation.PathOptimizationConstraint.body-param" + description: "tapi.path.computation.PathOptimizationConstraint to be added\ + \ or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" responses: 201: description: "Object created" @@ -9709,39 +10231,33 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.path.computation.PathOptimizationConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/name/: + /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name/: post: tags: - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - in: "body" name: "tapi.common.NameAndValue.body-param" description: "tapi.common.NameAndValue to be added to list" @@ -9755,22 +10271,20 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/name={value-name}/: + /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name={value-name}/: get: tags: - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - name: "value-name" in: "path" description: "Id of name" @@ -9783,21 +10297,19 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: + put: tags: - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - name: "value-name" in: "path" description: "Id of name" @@ -9805,7 +10317,7 @@ paths: type: "string" - in: "body" name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: $ref: "#/definitions/tapi.common.NameAndValue" @@ -9814,94 +10326,79 @@ paths: description: "Object created" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + 204: + description: "Object modified" + delete: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - name: "value-name" in: "path" description: "Id of name" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" responses: - 201: - description: "Object created" 400: description: "Internal error" 204: - description: "Object modified" - delete: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/path={path-uuid}/: + get: tags: - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" + summary: "returns tapi.path.computation.PathRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" + - name: "path-uuid" in: "path" - description: "Id of name" + description: "Id of path" required: true type: "string" responses: + 200: + description: "tapi.path.computation.PathRef" + schema: + $ref: "#/definitions/tapi.path.computation.PathRef" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/service-interface-point/: + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/: get: tags: - "tapi-path-computation" - description: "returns tapi.common.ServiceInterfacePointRef" + summary: "returns tapi.path.computation.RoutingConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" responses: 200: - description: "tapi.common.ServiceInterfacePointRef" + description: "tapi.path.computation.RoutingConstraint" schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" 400: description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/name/: post: tags: - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.path.computation.RoutingConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -9909,11 +10406,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.path.computation.RoutingConstraint.body-param" + description: "tapi.path.computation.RoutingConstraint to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" responses: 201: description: "Object created" @@ -9921,50 +10418,65 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/name={value-name}/: - get: + put: tags: - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" + summary: "creates or updates tapi.path.computation.RoutingConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "value-name" + - in: "body" + name: "tapi.path.computation.RoutingConstraint.body-param" + description: "tapi.path.computation.RoutingConstraint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" in: "path" - description: "Id of name" + description: "Id of path-comp-service" required: true type: "string" responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic/: post: tags: - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.topology.CostCharacteristic.body-param" + description: "tapi.topology.CostCharacteristic to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.topology.CostCharacteristic" responses: 201: description: "Object created" @@ -9972,27 +10484,54 @@ paths: description: "Internal error" 409: description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic={cost-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" put: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" + summary: "creates or updates tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "value-name" + - name: "cost-name" in: "path" - description: "Id of name" + description: "Id of cost-characteristic" required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" + name: "tapi.topology.CostCharacteristic.body-param" + description: "tapi.topology.CostCharacteristic to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.topology.CostCharacteristic" responses: 201: description: "Object created" @@ -10003,16 +10542,18 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "value-name" + - name: "cost-name" in: "path" - description: "Id of name" + description: "Id of cost-characteristic" required: true type: "string" responses: @@ -10020,63 +10561,80 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/objective-function/: - get: + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/latency-characteristic/: + post: tags: - "tapi-path-computation" - description: "returns tapi.path.computation.PathObjectiveFunction" + summary: "creates tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" + - in: "body" + name: "tapi.topology.LatencyCharacteristic.body-param" + description: "tapi.topology.LatencyCharacteristic to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" responses: - 200: - description: "tapi.path.computation.PathObjectiveFunction" - schema: - $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + ? /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/ + : get: tags: - "tapi-path-computation" - description: "creates tapi.path.computation.PathObjectiveFunction" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - in: "body" - name: "tapi.path.computation.PathObjectiveFunction.body-param" - description: "tapi.path.computation.PathObjectiveFunction to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" responses: - 201: - description: "Object created" + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathObjectiveFunction" + summary: "creates or updates tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" - in: "body" - name: "tapi.path.computation.PathObjectiveFunction.body-param" - description: "tapi.path.computation.PathObjectiveFunction to be added or updated" + name: "tapi.topology.LatencyCharacteristic.body-param" + description: "tapi.topology.LatencyCharacteristic to be added or updated" required: false schema: - $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" responses: 201: description: "Object created" @@ -10087,23 +10645,31 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.path.computation.PathObjectiveFunction" + summary: "removes tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/objective-function/name/: + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/risk-diversity-characteristic/: post: tags: - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" @@ -10111,11 +10677,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.topology.RiskCharacteristic.body-param" + description: "tapi.topology.RiskCharacteristic to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.topology.RiskCharacteristic" responses: 201: description: "Object created" @@ -10123,164 +10689,151 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/objective-function/name={value-name}/: - get: + ? /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/ + : get: tags: - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "value-name" + - name: "risk-characteristic-name" in: "path" - description: "Id of name" + description: "Id of risk-diversity-characteristic" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.topology.RiskCharacteristic" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.topology.RiskCharacteristic" 400: description: "Internal error" - post: + put: tags: - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" + summary: "creates or updates tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "value-name" + - name: "risk-characteristic-name" in: "path" - description: "Id of name" + description: "Id of risk-diversity-characteristic" required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.topology.RiskCharacteristic.body-param" + description: "tapi.topology.RiskCharacteristic to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.topology.RiskCharacteristic" responses: 201: description: "Object created" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + 204: + description: "Object modified" + delete: tags: - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" + summary: "removes tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "value-name" + - name: "risk-characteristic-name" in: "path" - description: "Id of name" + description: "Id of risk-diversity-characteristic" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" responses: - 201: - description: "Object created" 400: description: "Internal error" 204: - description: "Object modified" - delete: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/: + post: tags: - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" + summary: "creates tapi.path.computation.TopologyConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" + - in: "body" + name: "tapi.path.computation.TopologyConstraint.body-param" + description: "tapi.path.computation.TopologyConstraint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" responses: + 201: + description: "Object created" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/: + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint={local-id}/: get: tags: - "tapi-path-computation" - description: "returns tapi.path.computation.PathOptimizationConstraint" + summary: "returns tapi.path.computation.TopologyConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" responses: 200: - description: "tapi.path.computation.PathOptimizationConstraint" + description: "tapi.path.computation.TopologyConstraint" schema: - $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" 400: description: "Internal error" - post: + put: tags: - "tapi-path-computation" - description: "creates tapi.path.computation.PathOptimizationConstraint" + summary: "creates or updates tapi.path.computation.TopologyConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - in: "body" - name: "tapi.path.computation.PathOptimizationConstraint.body-param" - description: "tapi.path.computation.PathOptimizationConstraint to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathOptimizationConstraint" - parameters: - - name: "uuid" + - name: "local-id" in: "path" - description: "Id of path-comp-service" + description: "Id of topology-constraint" required: true type: "string" - in: "body" - name: "tapi.path.computation.PathOptimizationConstraint.body-param" - description: "tapi.path.computation.PathOptimizationConstraint to be added\ - \ or updated" + name: "tapi.path.computation.TopologyConstraint.body-param" + description: "tapi.path.computation.TopologyConstraint to be added or updated" required: false schema: - $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" responses: 201: description: "Object created" @@ -10291,29 +10844,43 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.path.computation.PathOptimizationConstraint" + summary: "removes tapi.path.computation.TopologyConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name/: + /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint={local-id}/name/: post: tags: - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" - in: "body" name: "tapi.common.NameAndValue.body-param" description: "tapi.common.NameAndValue to be added to list" @@ -10327,17 +10894,25 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name={value-name}/: + /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint={local-id}/name={value-name}/: get: tags: - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" - name: "value-name" in: "path" description: "Id of name" @@ -10350,42 +10925,22 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: + put: tags: - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" + - name: "local-id" in: "path" - description: "Id of path-comp-service" + description: "Id of topology-constraint" required: true type: "string" - name: "value-name" @@ -10409,13 +10964,21 @@ paths: delete: tags: - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" - name: "value-name" in: "path" description: "Id of name" @@ -10426,176 +10989,186 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/path={path-uuid}/: + /data/context/path-computation-context/path={uuid}/: get: tags: - "tapi-path-computation" - description: "returns tapi.path.computation.PathRef" + summary: "returns tapi.path.computation.Path" + description: "none" parameters: - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "path-uuid" in: "path" description: "Id of path" required: true type: "string" responses: 200: - description: "tapi.path.computation.PathRef" + description: "tapi.path.computation.Path" schema: - $ref: "#/definitions/tapi.path.computation.PathRef" + $ref: "#/definitions/tapi.path.computation.Path" 400: description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/: + /data/context/path-computation-context/path={uuid}/link={topology-uuid},{link-uuid}/: get: tags: - "tapi-path-computation" - description: "returns tapi.path.computation.RoutingConstraint" + summary: "returns tapi.topology.LinkRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of path" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" required: true type: "string" responses: 200: - description: "tapi.path.computation.RoutingConstraint" + description: "tapi.topology.LinkRef" schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + $ref: "#/definitions/tapi.topology.LinkRef" 400: description: "Internal error" - post: + /data/context/path-computation-context/path={uuid}/name={value-name}/: + get: tags: - "tapi-path-computation" - description: "creates tapi.path.computation.RoutingConstraint" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of path" required: true type: "string" - - in: "body" - name: "tapi.path.computation.RoutingConstraint.body-param" - description: "tapi.path.computation.RoutingConstraint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" + - name: "value-name" in: "path" - description: "Id of path-comp-service" + description: "Id of name" required: true type: "string" - - in: "body" - name: "tapi.path.computation.RoutingConstraint.body-param" - description: "tapi.path.computation.RoutingConstraint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" responses: - 201: - description: "Object created" + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + /data/context/path-computation-context/path={uuid}/routing-constraint/: + get: tags: - "tapi-path-computation" - description: "removes tapi.path.computation.RoutingConstraint" + summary: "returns tapi.path.computation.RoutingConstraint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of path" required: true type: "string" responses: + 200: + description: "tapi.path.computation.RoutingConstraint" + schema: + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic/: - post: + /data/context/path-computation-context/path={uuid}/routing-constraint/cost-characteristic={cost-name}/: + get: tags: - "tapi-path-computation" - description: "creates tapi.topology.CostCharacteristic" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of path" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" required: true type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" responses: - 201: - description: "Object created" + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic={cost-name}/: + /data/context/path-computation-context/path={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/: get: tags: - "tapi-path-computation" - description: "returns tapi.topology.CostCharacteristic" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of path" required: true type: "string" - - name: "cost-name" + - name: "traffic-property-name" in: "path" - description: "Id of cost-characteristic" + description: "Id of latency-characteristic" required: true type: "string" responses: 200: - description: "tapi.topology.CostCharacteristic" + description: "tapi.topology.LatencyCharacteristic" schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" - post: + /data/context/path-computation-context/path={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/: + get: tags: - "tapi-path-computation" - description: "creates tapi.topology.CostCharacteristic" + summary: "returns tapi.topology.RiskCharacteristic" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of path" required: true type: "string" - - name: "cost-name" + - name: "risk-characteristic-name" in: "path" - description: "Id of cost-characteristic" + description: "Id of risk-diversity-characteristic" required: true type: "string" + responses: + 200: + description: "tapi.topology.RiskCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" + 400: + description: "Internal error" + /data/context/service-interface-point/: + post: + tags: + - "tapi-common" + summary: "creates tapi.common.context.ServiceInterfacePoint" + description: "none" + parameters: - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" + name: "tapi.common.context.ServiceInterfacePoint.body-param" + description: "tapi.common.context.ServiceInterfacePoint to be added to list" required: false schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" + $ref: "#/definitions/tapi.common.context.ServiceInterfacePoint" responses: 201: description: "Object created" @@ -10603,27 +11176,42 @@ paths: description: "Internal error" 409: description: "Object already exists" - put: + /data/context/service-interface-point={uuid}/: + get: tags: - - "tapi-path-computation" - description: "creates or updates tapi.topology.CostCharacteristic" + - "tapi-common" + summary: "returns tapi.common.context.ServiceInterfacePoint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of service-interface-point" required: true type: "string" - - name: "cost-name" + responses: + 200: + description: "tapi.common.context.ServiceInterfacePoint" + schema: + $ref: "#/definitions/tapi.common.context.ServiceInterfacePoint" + 400: + description: "Internal error" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.context.ServiceInterfacePoint" + description: "none" + parameters: + - name: "uuid" in: "path" - description: "Id of cost-characteristic" + description: "Id of service-interface-point" required: true type: "string" - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added or updated" + name: "tapi.common.context.ServiceInterfacePoint.body-param" + description: "tapi.common.context.ServiceInterfacePoint to be added or updated" required: false schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" + $ref: "#/definitions/tapi.common.context.ServiceInterfacePoint" responses: 201: description: "Object created" @@ -10633,17 +11221,13 @@ paths: description: "Object modified" delete: tags: - - "tapi-path-computation" - description: "removes tapi.topology.CostCharacteristic" + - "tapi-common" + summary: "removes tapi.common.context.ServiceInterfacePoint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" + description: "Id of service-interface-point" required: true type: "string" responses: @@ -10651,74 +11235,82 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/latency-characteristic/: - post: + /data/context/service-interface-point={uuid}/available-capacity/: + get: tags: - - "tapi-path-computation" - description: "creates tapi.topology.LatencyCharacteristic" + - "tapi-common" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of service-interface-point" required: true type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" responses: - 201: - description: "Object created" + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - 409: - description: "Object already exists" - ? /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/ - : get: + /data/context/service-interface-point={uuid}/available-capacity/total-size/: + get: tags: - - "tapi-path-computation" - description: "returns tapi.topology.LatencyCharacteristic" + - "tapi-common" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of service-interface-point" required: true type: "string" - - name: "traffic-property-name" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/service-interface-point={uuid}/media-channel-service-interface-point-spec/: + get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.MediaChannelServiceInterfacePointSpec" + description: "none" + parameters: + - name: "uuid" in: "path" - description: "Id of latency-characteristic" + description: "Id of service-interface-point" required: true type: "string" responses: 200: - description: "tapi.topology.LatencyCharacteristic" + description: "tapi.photonic.media.MediaChannelServiceInterfacePointSpec" schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + $ref: "#/definitions/tapi.photonic.media.MediaChannelServiceInterfacePointSpec" 400: description: "Internal error" post: tags: - - "tapi-path-computation" - description: "creates tapi.topology.LatencyCharacteristic" + - "tapi-photonic-media" + summary: "creates tapi.photonic.media.MediaChannelServiceInterfacePointSpec" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" + description: "Id of service-interface-point" required: true type: "string" - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" + name: "tapi.photonic.media.MediaChannelServiceInterfacePointSpec.body-param" + description: "tapi.photonic.media.MediaChannelServiceInterfacePointSpec to\ + \ be added to list" required: false schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + $ref: "#/definitions/tapi.photonic.media.MediaChannelServiceInterfacePointSpec" responses: 201: description: "Object created" @@ -10728,25 +11320,22 @@ paths: description: "Object already exists" put: tags: - - "tapi-path-computation" - description: "creates or updates tapi.topology.LatencyCharacteristic" + - "tapi-photonic-media" + summary: "creates or updates tapi.photonic.media.MediaChannelServiceInterfacePointSpec" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" + description: "Id of service-interface-point" required: true type: "string" - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added or updated" + name: "tapi.photonic.media.MediaChannelServiceInterfacePointSpec.body-param" + description: "tapi.photonic.media.MediaChannelServiceInterfacePointSpec to\ + \ be added or updated" required: false schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + $ref: "#/definitions/tapi.photonic.media.MediaChannelServiceInterfacePointSpec" responses: 201: description: "Object created" @@ -10756,17 +11345,13 @@ paths: description: "Object modified" delete: tags: - - "tapi-path-computation" - description: "removes tapi.topology.LatencyCharacteristic" + - "tapi-photonic-media" + summary: "removes tapi.photonic.media.MediaChannelServiceInterfacePointSpec" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" + description: "Id of service-interface-point" required: true type: "string" responses: @@ -10774,163 +11359,248 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/risk-diversity-characteristic/: - post: + /data/context/service-interface-point={uuid}/media-channel-service-interface-point-spec/mc-pool/: + get: tags: - - "tapi-path-computation" - description: "creates tapi.topology.RiskCharacteristic" + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.MediaChannelPoolCapabilityPac" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of service-interface-point" required: true type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" responses: - 201: - description: "Object created" + 200: + description: "tapi.photonic.media.MediaChannelPoolCapabilityPac" + schema: + $ref: "#/definitions/tapi.photonic.media.MediaChannelPoolCapabilityPac" 400: description: "Internal error" - 409: - description: "Object already exists" - ? /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/ + ? /data/context/service-interface-point={uuid}/media-channel-service-interface-point-spec/mc-pool/available-spectrum={upper-frequency},{lower-frequency}/ : get: tags: - - "tapi-path-computation" - description: "returns tapi.topology.RiskCharacteristic" + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.SpectrumBand" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of service-interface-point" required: true type: "string" - - name: "risk-characteristic-name" + - name: "upper-frequency" in: "path" - description: "Id of risk-diversity-characteristic" + description: "Id of available-spectrum" required: true - type: "string" + type: "integer" + format: "int32" + - name: "lower-frequency" + in: "path" + description: "Id of available-spectrum" + required: true + type: "integer" + format: "int32" responses: 200: - description: "tapi.topology.RiskCharacteristic" + description: "tapi.photonic.media.SpectrumBand" schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" + $ref: "#/definitions/tapi.photonic.media.SpectrumBand" 400: description: "Internal error" - post: + ? /data/context/service-interface-point={uuid}/media-channel-service-interface-point-spec/mc-pool/available-spectrum={upper-frequency},{lower-frequency}/frequency-constraint/ + : get: tags: - - "tapi-path-computation" - description: "creates tapi.topology.RiskCharacteristic" + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.FrequencyConstraint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of service-interface-point" required: true type: "string" - - name: "risk-characteristic-name" + - name: "upper-frequency" in: "path" - description: "Id of risk-diversity-characteristic" + description: "Id of available-spectrum" required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" + type: "integer" + format: "int32" + - name: "lower-frequency" + in: "path" + description: "Id of available-spectrum" + required: true + type: "integer" + format: "int32" responses: - 201: - description: "Object created" + 200: + description: "tapi.photonic.media.FrequencyConstraint" + schema: + $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + ? /data/context/service-interface-point={uuid}/media-channel-service-interface-point-spec/mc-pool/occupied-spectrum={upper-frequency},{lower-frequency}/ + : get: tags: - - "tapi-path-computation" - description: "creates or updates tapi.topology.RiskCharacteristic" + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.SpectrumBand" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of service-interface-point" required: true type: "string" - - name: "risk-characteristic-name" + - name: "upper-frequency" in: "path" - description: "Id of risk-diversity-characteristic" + description: "Id of occupied-spectrum" required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" + type: "integer" + format: "int32" + - name: "lower-frequency" + in: "path" + description: "Id of occupied-spectrum" + required: true + type: "integer" + format: "int32" responses: - 201: - description: "Object created" + 200: + description: "tapi.photonic.media.SpectrumBand" + schema: + $ref: "#/definitions/tapi.photonic.media.SpectrumBand" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + ? /data/context/service-interface-point={uuid}/media-channel-service-interface-point-spec/mc-pool/occupied-spectrum={upper-frequency},{lower-frequency}/frequency-constraint/ + : get: tags: - - "tapi-path-computation" - description: "removes tapi.topology.RiskCharacteristic" + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.FrequencyConstraint" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of service-interface-point" required: true type: "string" - - name: "risk-characteristic-name" + - name: "upper-frequency" in: "path" - description: "Id of risk-diversity-characteristic" + description: "Id of occupied-spectrum" + required: true + type: "integer" + format: "int32" + - name: "lower-frequency" + in: "path" + description: "Id of occupied-spectrum" + required: true + type: "integer" + format: "int32" + responses: + 200: + description: "tapi.photonic.media.FrequencyConstraint" + schema: + $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" + 400: + description: "Internal error" + ? /data/context/service-interface-point={uuid}/media-channel-service-interface-point-spec/mc-pool/supportable-spectrum={upper-frequency},{lower-frequency}/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.SpectrumBand" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - name: "upper-frequency" + in: "path" + description: "Id of supportable-spectrum" + required: true + type: "integer" + format: "int32" + - name: "lower-frequency" + in: "path" + description: "Id of supportable-spectrum" + required: true + type: "integer" + format: "int32" + responses: + 200: + description: "tapi.photonic.media.SpectrumBand" + schema: + $ref: "#/definitions/tapi.photonic.media.SpectrumBand" + 400: + description: "Internal error" + ? /data/context/service-interface-point={uuid}/media-channel-service-interface-point-spec/mc-pool/supportable-spectrum={upper-frequency},{lower-frequency}/frequency-constraint/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.FrequencyConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" required: true type: "string" + - name: "upper-frequency" + in: "path" + description: "Id of supportable-spectrum" + required: true + type: "integer" + format: "int32" + - name: "lower-frequency" + in: "path" + description: "Id of supportable-spectrum" + required: true + type: "integer" + format: "int32" responses: + 200: + description: "tapi.photonic.media.FrequencyConstraint" + schema: + $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/: + /data/context/service-interface-point={uuid}/media-channel-service-interface-point-spec/power-management-capability/: get: tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.TopologyConstraint" + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.PowerManagementCapabilityPac" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of service-interface-point" required: true type: "string" responses: 200: - description: "tapi.path.computation.TopologyConstraint" + description: "tapi.photonic.media.PowerManagementCapabilityPac" schema: - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + $ref: "#/definitions/tapi.photonic.media.PowerManagementCapabilityPac" 400: description: "Internal error" post: tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.TopologyConstraint" + - "tapi-photonic-media" + summary: "creates tapi.photonic.media.PowerManagementCapabilityPac" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of service-interface-point" required: true type: "string" - in: "body" - name: "tapi.path.computation.TopologyConstraint.body-param" - description: "tapi.path.computation.TopologyConstraint to be added to list" + name: "tapi.photonic.media.PowerManagementCapabilityPac.body-param" + description: "tapi.photonic.media.PowerManagementCapabilityPac to be added\ + \ to list" required: false schema: - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + $ref: "#/definitions/tapi.photonic.media.PowerManagementCapabilityPac" responses: 201: description: "Object created" @@ -10940,20 +11610,22 @@ paths: description: "Object already exists" put: tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.TopologyConstraint" + - "tapi-photonic-media" + summary: "creates or updates tapi.photonic.media.PowerManagementCapabilityPac" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of service-interface-point" required: true type: "string" - in: "body" - name: "tapi.path.computation.TopologyConstraint.body-param" - description: "tapi.path.computation.TopologyConstraint to be added or updated" + name: "tapi.photonic.media.PowerManagementCapabilityPac.body-param" + description: "tapi.photonic.media.PowerManagementCapabilityPac to be added\ + \ or updated" required: false schema: - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + $ref: "#/definitions/tapi.photonic.media.PowerManagementCapabilityPac" responses: 201: description: "Object created" @@ -10963,12 +11635,13 @@ paths: description: "Object modified" delete: tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.TopologyConstraint" + - "tapi-photonic-media" + summary: "removes tapi.photonic.media.PowerManagementCapabilityPac" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" + description: "Id of service-interface-point" required: true type: "string" responses: @@ -10976,390 +11649,351 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/avoid-topology={topology-uuid}/: - get: + ? /data/context/service-interface-point={uuid}/media-channel-service-interface-point-spec/power-management-capability/supportable-maximum-output-power/ + : get: tags: - - "tapi-path-computation" - description: "returns tapi.topology.TopologyRef" + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.PowerProperties" + description: "This parameter exposes the maximum output power supported\r\n\ + \ at the Logical-Termination-Point (LTP) associated to the\ + \ SIP." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of avoid-topology" + description: "Id of service-interface-point" required: true type: "string" responses: 200: - description: "tapi.topology.TopologyRef" + description: "tapi.photonic.media.PowerProperties" schema: - $ref: "#/definitions/tapi.topology.TopologyRef" + $ref: "#/definitions/tapi.photonic.media.PowerProperties" 400: description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/exclude-link={topology-uuid},{link-uuid}/: - get: + post: tags: - - "tapi-path-computation" - description: "returns tapi.topology.LinkRef" + - "tapi-photonic-media" + summary: "creates tapi.photonic.media.PowerProperties" + description: "This parameter exposes the maximum output power supported\r\n\ + \ at the Logical-Termination-Point (LTP) associated to the\ + \ SIP." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of exclude-link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of exclude-link" + description: "Id of service-interface-point" required: true type: "string" + - in: "body" + name: "tapi.photonic.media.PowerProperties.body-param" + description: "tapi.photonic.media.PowerProperties to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/exclude-node={topology-uuid},{node-uuid}/: - get: + 409: + description: "Object already exists" + put: tags: - - "tapi-path-computation" - description: "returns tapi.topology.NodeRef" + - "tapi-photonic-media" + summary: "creates or updates tapi.photonic.media.PowerProperties" + description: "This parameter exposes the maximum output power supported\r\n\ + \ at the Logical-Termination-Point (LTP) associated to the\ + \ SIP." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of exclude-node" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of exclude-node" + description: "Id of service-interface-point" required: true type: "string" + - in: "body" + name: "tapi.photonic.media.PowerProperties.body-param" + description: "tapi.photonic.media.PowerProperties to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" responses: - 200: - description: "tapi.topology.NodeRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRef" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/exclude-path={path-uuid}/: - get: + 204: + description: "Object modified" + delete: tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathRef" + - "tapi-photonic-media" + summary: "removes tapi.photonic.media.PowerProperties" + description: "This parameter exposes the maximum output power supported\r\n\ + \ at the Logical-Termination-Point (LTP) associated to the\ + \ SIP." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "path-uuid" - in: "path" - description: "Id of exclude-path" + description: "Id of service-interface-point" required: true type: "string" responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" 400: description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-link={topology-uuid},{link-uuid}/: - get: + 204: + description: "Object deleted" + ? /data/context/service-interface-point={uuid}/media-channel-service-interface-point-spec/power-management-capability/supportable-minimum-output-power/ + : get: tags: - - "tapi-path-computation" - description: "returns tapi.topology.LinkRef" + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.PowerProperties" + description: "This parameter exposes the minimum output power supported\r\n\ + \ at the Logical-Termination-Point (LTP) associated to the\ + \ SIP." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of include-link" + description: "Id of service-interface-point" required: true type: "string" responses: 200: - description: "tapi.topology.LinkRef" + description: "tapi.photonic.media.PowerProperties" schema: - $ref: "#/definitions/tapi.topology.LinkRef" + $ref: "#/definitions/tapi.photonic.media.PowerProperties" 400: description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-node={topology-uuid},{node-uuid}/: - get: + post: tags: - - "tapi-path-computation" - description: "returns tapi.topology.NodeRef" + - "tapi-photonic-media" + summary: "creates tapi.photonic.media.PowerProperties" + description: "This parameter exposes the minimum output power supported\r\n\ + \ at the Logical-Termination-Point (LTP) associated to the\ + \ SIP." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-node" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of include-node" + description: "Id of service-interface-point" required: true type: "string" + - in: "body" + name: "tapi.photonic.media.PowerProperties.body-param" + description: "tapi.photonic.media.PowerProperties to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" responses: - 200: - description: "tapi.topology.NodeRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRef" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-path={path-uuid}/: - get: + 409: + description: "Object already exists" + put: tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathRef" + - "tapi-photonic-media" + summary: "creates or updates tapi.photonic.media.PowerProperties" + description: "This parameter exposes the minimum output power supported\r\n\ + \ at the Logical-Termination-Point (LTP) associated to the\ + \ SIP." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "path-uuid" - in: "path" - description: "Id of include-path" + description: "Id of service-interface-point" required: true type: "string" + - in: "body" + name: "tapi.photonic.media.PowerProperties.body-param" + description: "tapi.photonic.media.PowerProperties to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-topology={topology-uuid}/: - get: + 204: + description: "Object modified" + delete: tags: - - "tapi-path-computation" - description: "returns tapi.topology.TopologyRef" + - "tapi-photonic-media" + summary: "removes tapi.photonic.media.PowerProperties" + description: "This parameter exposes the minimum output power supported\r\n\ + \ at the Logical-Termination-Point (LTP) associated to the\ + \ SIP." parameters: - name: "uuid" in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-topology" + description: "Id of service-interface-point" required: true type: "string" responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" 400: description: "Internal error" - /data/context/path-computation-context/path={uuid}/: - get: + 204: + description: "Object deleted" + ? /data/context/service-interface-point={uuid}/media-channel-service-interface-point-spec/power-management-capability/tolerable-maximum-input-power/ + : get: tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.Path" + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.PowerProperties" + description: "This parameter exposes the maximum input power tolerated\r\n \ + \ at the Logical-Termination-Point (LTP) associated to the SIP." parameters: - name: "uuid" in: "path" - description: "Id of path" + description: "Id of service-interface-point" required: true type: "string" responses: 200: - description: "tapi.path.computation.Path" + description: "tapi.photonic.media.PowerProperties" schema: - $ref: "#/definitions/tapi.path.computation.Path" + $ref: "#/definitions/tapi.photonic.media.PowerProperties" 400: description: "Internal error" - /data/context/path-computation-context/path={uuid}/link={topology-uuid},{link-uuid}/: - get: + post: tags: - - "tapi-path-computation" - description: "returns tapi.topology.LinkRef" + - "tapi-photonic-media" + summary: "creates tapi.photonic.media.PowerProperties" + description: "This parameter exposes the maximum input power tolerated\r\n \ + \ at the Logical-Termination-Point (LTP) associated to the SIP." parameters: - name: "uuid" in: "path" - description: "Id of path" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" + description: "Id of service-interface-point" required: true type: "string" + - in: "body" + name: "tapi.photonic.media.PowerProperties.body-param" + description: "tapi.photonic.media.PowerProperties to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/path-computation-context/path={uuid}/name={value-name}/: - get: + 409: + description: "Object already exists" + put: tags: - - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" + - "tapi-photonic-media" + summary: "creates or updates tapi.photonic.media.PowerProperties" + description: "This parameter exposes the maximum input power tolerated\r\n \ + \ at the Logical-Termination-Point (LTP) associated to the SIP." parameters: - name: "uuid" in: "path" - description: "Id of path" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" + description: "Id of service-interface-point" required: true type: "string" + - in: "body" + name: "tapi.photonic.media.PowerProperties.body-param" + description: "tapi.photonic.media.PowerProperties to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/path-computation-context/path={uuid}/routing-constraint/: - get: + 204: + description: "Object modified" + delete: tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.RoutingConstraint" + - "tapi-photonic-media" + summary: "removes tapi.photonic.media.PowerProperties" + description: "This parameter exposes the maximum input power tolerated\r\n \ + \ at the Logical-Termination-Point (LTP) associated to the SIP." parameters: - name: "uuid" in: "path" - description: "Id of path" + description: "Id of service-interface-point" required: true type: "string" responses: - 200: - description: "tapi.path.computation.RoutingConstraint" - schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" 400: description: "Internal error" - /data/context/path-computation-context/path={uuid}/routing-constraint/cost-characteristic={cost-name}/: - get: + 204: + description: "Object deleted" + ? /data/context/service-interface-point={uuid}/media-channel-service-interface-point-spec/power-management-capability/tolerable-minimum-input-power/ + : get: tags: - - "tapi-path-computation" - description: "returns tapi.topology.CostCharacteristic" + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.PowerProperties" + description: "This parameter exposes the minimum input power tolerated\r\n \ + \ at the Logical-Termination-Point (LTP) associated to the SIP." parameters: - name: "uuid" in: "path" - description: "Id of path" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" + description: "Id of service-interface-point" required: true type: "string" responses: 200: - description: "tapi.topology.CostCharacteristic" + description: "tapi.photonic.media.PowerProperties" schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" + $ref: "#/definitions/tapi.photonic.media.PowerProperties" 400: description: "Internal error" - /data/context/path-computation-context/path={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/: - get: + post: tags: - - "tapi-path-computation" - description: "returns tapi.topology.LatencyCharacteristic" + - "tapi-photonic-media" + summary: "creates tapi.photonic.media.PowerProperties" + description: "This parameter exposes the minimum input power tolerated\r\n \ + \ at the Logical-Termination-Point (LTP) associated to the SIP." parameters: - name: "uuid" in: "path" - description: "Id of path" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" + description: "Id of service-interface-point" required: true type: "string" + - in: "body" + name: "tapi.photonic.media.PowerProperties.body-param" + description: "tapi.photonic.media.PowerProperties to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/path-computation-context/path={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/: - get: + 409: + description: "Object already exists" + put: tags: - - "tapi-path-computation" - description: "returns tapi.topology.RiskCharacteristic" + - "tapi-photonic-media" + summary: "creates or updates tapi.photonic.media.PowerProperties" + description: "This parameter exposes the minimum input power tolerated\r\n \ + \ at the Logical-Termination-Point (LTP) associated to the SIP." parameters: - name: "uuid" in: "path" - description: "Id of path" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" + description: "Id of service-interface-point" required: true type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - /data/context/service-interface-point/: - post: - tags: - - "tapi-common" - description: "creates tapi.common.context.ServiceInterfacePoint" - parameters: - in: "body" - name: "tapi.common.context.ServiceInterfacePoint.body-param" - description: "tapi.common.context.ServiceInterfacePoint to be added to list" + name: "tapi.photonic.media.PowerProperties.body-param" + description: "tapi.photonic.media.PowerProperties to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.context.ServiceInterfacePoint" + $ref: "#/definitions/tapi.photonic.media.PowerProperties" responses: 201: description: "Object created" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/service-interface-point={uuid}/: - get: + 204: + description: "Object modified" + delete: tags: - - "tapi-common" - description: "returns tapi.common.context.ServiceInterfacePoint" + - "tapi-photonic-media" + summary: "removes tapi.photonic.media.PowerProperties" + description: "This parameter exposes the minimum input power tolerated\r\n \ + \ at the Logical-Termination-Point (LTP) associated to the SIP." parameters: - name: "uuid" in: "path" @@ -11367,16 +12001,18 @@ paths: required: true type: "string" responses: - 200: - description: "tapi.common.context.ServiceInterfacePoint" - schema: - $ref: "#/definitions/tapi.common.context.ServiceInterfacePoint" 400: description: "Internal error" + 204: + description: "Object deleted" + /data/context/service-interface-point={uuid}/name/: post: tags: - "tapi-common" - description: "creates tapi.common.context.ServiceInterfacePoint" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -11384,11 +12020,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.context.ServiceInterfacePoint.body-param" - description: "tapi.common.context.ServiceInterfacePoint to be added to list" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.context.ServiceInterfacePoint" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -11396,22 +12032,56 @@ paths: description: "Internal error" 409: description: "Object already exists" + /data/context/service-interface-point={uuid}/name={value-name}/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" put: tags: - "tapi-common" - description: "creates or updates tapi.common.context.ServiceInterfacePoint" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of service-interface-point" required: true type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" - in: "body" - name: "tapi.common.context.ServiceInterfacePoint.body-param" - description: "tapi.common.context.ServiceInterfacePoint to be added or updated" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.context.ServiceInterfacePoint" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -11422,23 +12092,32 @@ paths: delete: tags: - "tapi-common" - description: "removes tapi.common.context.ServiceInterfacePoint" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of service-interface-point" required: true type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/service-interface-point={uuid}/available-capacity/: + /data/context/service-interface-point={uuid}/otsi-service-interface-point-spec/: get: tags: - - "tapi-common" - description: "returns tapi.common.Capacity" + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.OtsiServiceInterfacePointSpec" + description: "none" parameters: - name: "uuid" in: "path" @@ -11447,34 +12126,83 @@ paths: type: "string" responses: 200: - description: "tapi.common.Capacity" + description: "tapi.photonic.media.OtsiServiceInterfacePointSpec" schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.photonic.media.OtsiServiceInterfacePointSpec" 400: description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/: - get: + post: tags: - - "tapi-common" - description: "returns tapi.common.BandwidthProfile" + - "tapi-photonic-media" + summary: "creates tapi.photonic.media.OtsiServiceInterfacePointSpec" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of service-interface-point" required: true type: "string" + - in: "body" + name: "tapi.photonic.media.OtsiServiceInterfacePointSpec.body-param" + description: "tapi.photonic.media.OtsiServiceInterfacePointSpec to be added\ + \ to list" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.OtsiServiceInterfacePointSpec" responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/committed-burst-size/: + 409: + description: "Object already exists" + put: + tags: + - "tapi-photonic-media" + summary: "creates or updates tapi.photonic.media.OtsiServiceInterfacePointSpec" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.photonic.media.OtsiServiceInterfacePointSpec.body-param" + description: "tapi.photonic.media.OtsiServiceInterfacePointSpec to be added\ + \ or updated" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.OtsiServiceInterfacePointSpec" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-photonic-media" + summary: "removes tapi.photonic.media.OtsiServiceInterfacePointSpec" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/service-interface-point={uuid}/otsi-service-interface-point-spec/otsi-capability/: get: tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.OtsiCapabilityPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -11483,34 +12211,45 @@ paths: type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.photonic.media.OtsiCapabilityPac" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.photonic.media.OtsiCapabilityPac" 400: description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/committed-information-rate/: - get: + ? /data/context/service-interface-point={uuid}/otsi-service-interface-point-spec/otsi-capability/supportable-application-identifier={application-code}/ + : get: tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.ApplicationIdentifier" + description: "The list of supportable ApplicationIdentifiers." parameters: - name: "uuid" in: "path" description: "Id of service-interface-point" required: true type: "string" + - name: "application-code" + in: "path" + description: "Id of supportable-application-identifier" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.photonic.media.ApplicationIdentifier" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.photonic.media.ApplicationIdentifier" 400: description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/peak-burst-size/: - get: + ? /data/context/service-interface-point={uuid}/otsi-service-interface-point-spec/otsi-capability/supportable-central-frequency-band/ + : get: tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.CentralFrequencyBand" + description: "Each spectrum band supported for otsi trasmitter to be tuned on,\ + \ is specified\r\n as per it's lower and upper central frequencies\ + \ supported and its frequency constraints,\r\n consisting in\ + \ the frequency Grid and the AdjustmentGranularity, used to uniquely identify\ + \ all\r\n central frequencies supported within the band." parameters: - name: "uuid" in: "path" @@ -11519,16 +12258,17 @@ paths: type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.photonic.media.CentralFrequencyBand" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.photonic.media.CentralFrequencyBand" 400: description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/peak-information-rate/: - get: + ? /data/context/service-interface-point={uuid}/otsi-service-interface-point-spec/otsi-capability/supportable-central-frequency-band/frequency-constraint/ + : get: tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.FrequencyConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -11537,16 +12277,17 @@ paths: type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.photonic.media.FrequencyConstraint" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" 400: description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/total-size/: + /data/context/service-interface-point={uuid}/otsi-service-interface-point-spec/otsi-capability/total-power-warn-threshold/: get: tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.TotalPowerThresholdPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -11555,16 +12296,17 @@ paths: type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.photonic.media.TotalPowerThresholdPac" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.photonic.media.TotalPowerThresholdPac" 400: description: "Internal error" - /data/context/service-interface-point={uuid}/media-channel-service-interface-point-spec/: + /data/context/service-interface-point={uuid}/otsi-service-interface-point-spec/power-management-capability/: get: tags: - "tapi-photonic-media" - description: "returns tapi.photonic.media.MediaChannelServiceInterfacePointSpec" + summary: "returns tapi.photonic.media.PowerManagementCapabilityPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -11573,15 +12315,16 @@ paths: type: "string" responses: 200: - description: "tapi.photonic.media.MediaChannelServiceInterfacePointSpec" + description: "tapi.photonic.media.PowerManagementCapabilityPac" schema: - $ref: "#/definitions/tapi.photonic.media.MediaChannelServiceInterfacePointSpec" + $ref: "#/definitions/tapi.photonic.media.PowerManagementCapabilityPac" 400: description: "Internal error" post: tags: - "tapi-photonic-media" - description: "creates tapi.photonic.media.MediaChannelServiceInterfacePointSpec" + summary: "creates tapi.photonic.media.PowerManagementCapabilityPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -11589,12 +12332,12 @@ paths: required: true type: "string" - in: "body" - name: "tapi.photonic.media.MediaChannelServiceInterfacePointSpec.body-param" - description: "tapi.photonic.media.MediaChannelServiceInterfacePointSpec to\ - \ be added to list" + name: "tapi.photonic.media.PowerManagementCapabilityPac.body-param" + description: "tapi.photonic.media.PowerManagementCapabilityPac to be added\ + \ to list" required: false schema: - $ref: "#/definitions/tapi.photonic.media.MediaChannelServiceInterfacePointSpec" + $ref: "#/definitions/tapi.photonic.media.PowerManagementCapabilityPac" responses: 201: description: "Object created" @@ -11605,7 +12348,8 @@ paths: put: tags: - "tapi-photonic-media" - description: "creates or updates tapi.photonic.media.MediaChannelServiceInterfacePointSpec" + summary: "creates or updates tapi.photonic.media.PowerManagementCapabilityPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -11613,12 +12357,12 @@ paths: required: true type: "string" - in: "body" - name: "tapi.photonic.media.MediaChannelServiceInterfacePointSpec.body-param" - description: "tapi.photonic.media.MediaChannelServiceInterfacePointSpec to\ - \ be added or updated" + name: "tapi.photonic.media.PowerManagementCapabilityPac.body-param" + description: "tapi.photonic.media.PowerManagementCapabilityPac to be added\ + \ or updated" required: false schema: - $ref: "#/definitions/tapi.photonic.media.MediaChannelServiceInterfacePointSpec" + $ref: "#/definitions/tapi.photonic.media.PowerManagementCapabilityPac" responses: 201: description: "Object created" @@ -11629,7 +12373,8 @@ paths: delete: tags: - "tapi-photonic-media" - description: "removes tapi.photonic.media.MediaChannelServiceInterfacePointSpec" + summary: "removes tapi.photonic.media.PowerManagementCapabilityPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -11641,11 +12386,14 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/service-interface-point={uuid}/media-channel-service-interface-point-spec/mc-pool/: - get: + ? /data/context/service-interface-point={uuid}/otsi-service-interface-point-spec/power-management-capability/supportable-maximum-output-power/ + : get: tags: - "tapi-photonic-media" - description: "returns tapi.photonic.media.MediaChannelPoolCapabilityPac" + summary: "returns tapi.photonic.media.PowerProperties" + description: "This parameter exposes the maximum output power supported\r\n\ + \ at the Logical-Termination-Point (LTP) associated to the\ + \ SIP." parameters: - name: "uuid" in: "path" @@ -11654,259 +12402,210 @@ paths: type: "string" responses: 200: - description: "tapi.photonic.media.MediaChannelPoolCapabilityPac" + description: "tapi.photonic.media.PowerProperties" schema: - $ref: "#/definitions/tapi.photonic.media.MediaChannelPoolCapabilityPac" + $ref: "#/definitions/tapi.photonic.media.PowerProperties" 400: description: "Internal error" - ? /data/context/service-interface-point={uuid}/media-channel-service-interface-point-spec/mc-pool/available-spectrum={upper-frequency},{lower-frequency}/ - : get: + post: tags: - "tapi-photonic-media" - description: "returns tapi.photonic.media.SpectrumBand" + summary: "creates tapi.photonic.media.PowerProperties" + description: "This parameter exposes the maximum output power supported\r\n\ + \ at the Logical-Termination-Point (LTP) associated to the\ + \ SIP." parameters: - name: "uuid" in: "path" description: "Id of service-interface-point" required: true type: "string" - - name: "upper-frequency" - in: "path" - description: "Id of available-spectrum" - required: true - type: "integer" - format: "int32" - - name: "lower-frequency" - in: "path" - description: "Id of available-spectrum" - required: true - type: "integer" - format: "int32" + - in: "body" + name: "tapi.photonic.media.PowerProperties.body-param" + description: "tapi.photonic.media.PowerProperties to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" responses: - 200: - description: "tapi.photonic.media.SpectrumBand" - schema: - $ref: "#/definitions/tapi.photonic.media.SpectrumBand" + 201: + description: "Object created" 400: description: "Internal error" - ? /data/context/service-interface-point={uuid}/media-channel-service-interface-point-spec/mc-pool/available-spectrum={upper-frequency},{lower-frequency}/frequency-constraint/ - : get: + 409: + description: "Object already exists" + put: tags: - "tapi-photonic-media" - description: "returns tapi.photonic.media.FrequencyConstraint" + summary: "creates or updates tapi.photonic.media.PowerProperties" + description: "This parameter exposes the maximum output power supported\r\n\ + \ at the Logical-Termination-Point (LTP) associated to the\ + \ SIP." parameters: - name: "uuid" in: "path" description: "Id of service-interface-point" required: true type: "string" - - name: "upper-frequency" - in: "path" - description: "Id of available-spectrum" - required: true - type: "integer" - format: "int32" - - name: "lower-frequency" - in: "path" - description: "Id of available-spectrum" - required: true - type: "integer" - format: "int32" + - in: "body" + name: "tapi.photonic.media.PowerProperties.body-param" + description: "tapi.photonic.media.PowerProperties to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" responses: - 200: - description: "tapi.photonic.media.FrequencyConstraint" - schema: - $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" + 201: + description: "Object created" 400: description: "Internal error" - ? /data/context/service-interface-point={uuid}/media-channel-service-interface-point-spec/mc-pool/occupied-spectrum={upper-frequency},{lower-frequency}/ - : get: + 204: + description: "Object modified" + delete: tags: - "tapi-photonic-media" - description: "returns tapi.photonic.media.SpectrumBand" + summary: "removes tapi.photonic.media.PowerProperties" + description: "This parameter exposes the maximum output power supported\r\n\ + \ at the Logical-Termination-Point (LTP) associated to the\ + \ SIP." parameters: - name: "uuid" in: "path" description: "Id of service-interface-point" required: true type: "string" - - name: "upper-frequency" - in: "path" - description: "Id of occupied-spectrum" - required: true - type: "integer" - format: "int32" - - name: "lower-frequency" - in: "path" - description: "Id of occupied-spectrum" - required: true - type: "integer" - format: "int32" responses: - 200: - description: "tapi.photonic.media.SpectrumBand" - schema: - $ref: "#/definitions/tapi.photonic.media.SpectrumBand" 400: description: "Internal error" - ? /data/context/service-interface-point={uuid}/media-channel-service-interface-point-spec/mc-pool/occupied-spectrum={upper-frequency},{lower-frequency}/frequency-constraint/ + 204: + description: "Object deleted" + ? /data/context/service-interface-point={uuid}/otsi-service-interface-point-spec/power-management-capability/supportable-minimum-output-power/ : get: tags: - "tapi-photonic-media" - description: "returns tapi.photonic.media.FrequencyConstraint" + summary: "returns tapi.photonic.media.PowerProperties" + description: "This parameter exposes the minimum output power supported\r\n\ + \ at the Logical-Termination-Point (LTP) associated to the\ + \ SIP." parameters: - name: "uuid" in: "path" description: "Id of service-interface-point" required: true type: "string" - - name: "upper-frequency" - in: "path" - description: "Id of occupied-spectrum" - required: true - type: "integer" - format: "int32" - - name: "lower-frequency" - in: "path" - description: "Id of occupied-spectrum" - required: true - type: "integer" - format: "int32" responses: 200: - description: "tapi.photonic.media.FrequencyConstraint" + description: "tapi.photonic.media.PowerProperties" schema: - $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" + $ref: "#/definitions/tapi.photonic.media.PowerProperties" 400: description: "Internal error" - ? /data/context/service-interface-point={uuid}/media-channel-service-interface-point-spec/mc-pool/supportable-spectrum={upper-frequency},{lower-frequency}/ - : get: + post: tags: - "tapi-photonic-media" - description: "returns tapi.photonic.media.SpectrumBand" + summary: "creates tapi.photonic.media.PowerProperties" + description: "This parameter exposes the minimum output power supported\r\n\ + \ at the Logical-Termination-Point (LTP) associated to the\ + \ SIP." parameters: - name: "uuid" in: "path" description: "Id of service-interface-point" required: true type: "string" - - name: "upper-frequency" - in: "path" - description: "Id of supportable-spectrum" - required: true - type: "integer" - format: "int32" - - name: "lower-frequency" - in: "path" - description: "Id of supportable-spectrum" - required: true - type: "integer" - format: "int32" + - in: "body" + name: "tapi.photonic.media.PowerProperties.body-param" + description: "tapi.photonic.media.PowerProperties to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" responses: - 200: - description: "tapi.photonic.media.SpectrumBand" - schema: - $ref: "#/definitions/tapi.photonic.media.SpectrumBand" + 201: + description: "Object created" 400: description: "Internal error" - ? /data/context/service-interface-point={uuid}/media-channel-service-interface-point-spec/mc-pool/supportable-spectrum={upper-frequency},{lower-frequency}/frequency-constraint/ - : get: + 409: + description: "Object already exists" + put: tags: - "tapi-photonic-media" - description: "returns tapi.photonic.media.FrequencyConstraint" + summary: "creates or updates tapi.photonic.media.PowerProperties" + description: "This parameter exposes the minimum output power supported\r\n\ + \ at the Logical-Termination-Point (LTP) associated to the\ + \ SIP." parameters: - name: "uuid" in: "path" description: "Id of service-interface-point" required: true type: "string" - - name: "upper-frequency" - in: "path" - description: "Id of supportable-spectrum" - required: true - type: "integer" - format: "int32" - - name: "lower-frequency" - in: "path" - description: "Id of supportable-spectrum" - required: true - type: "integer" - format: "int32" + - in: "body" + name: "tapi.photonic.media.PowerProperties.body-param" + description: "tapi.photonic.media.PowerProperties to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" responses: - 200: - description: "tapi.photonic.media.FrequencyConstraint" - schema: - $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/service-interface-point={uuid}/name/: - post: + 204: + description: "Object modified" + delete: tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" + - "tapi-photonic-media" + summary: "removes tapi.photonic.media.PowerProperties" + description: "This parameter exposes the minimum output power supported\r\n\ + \ at the Logical-Termination-Point (LTP) associated to the\ + \ SIP." parameters: - name: "uuid" in: "path" description: "Id of service-interface-point" required: true type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" responses: - 201: - description: "Object created" 400: description: "Internal error" - 409: - description: "Object already exists" - /data/context/service-interface-point={uuid}/name={value-name}/: - get: + 204: + description: "Object deleted" + ? /data/context/service-interface-point={uuid}/otsi-service-interface-point-spec/power-management-capability/tolerable-maximum-input-power/ + : get: tags: - - "tapi-common" - description: "returns tapi.common.NameAndValue" + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.PowerProperties" + description: "This parameter exposes the maximum input power tolerated\r\n \ + \ at the Logical-Termination-Point (LTP) associated to the SIP." parameters: - name: "uuid" in: "path" description: "Id of service-interface-point" required: true type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.photonic.media.PowerProperties" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.photonic.media.PowerProperties" 400: description: "Internal error" post: tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" + - "tapi-photonic-media" + summary: "creates tapi.photonic.media.PowerProperties" + description: "This parameter exposes the maximum input power tolerated\r\n \ + \ at the Logical-Termination-Point (LTP) associated to the SIP." parameters: - name: "uuid" in: "path" description: "Id of service-interface-point" required: true type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + name: "tapi.photonic.media.PowerProperties.body-param" + description: "tapi.photonic.media.PowerProperties to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.photonic.media.PowerProperties" responses: 201: description: "Object created" @@ -11916,25 +12615,22 @@ paths: description: "Object already exists" put: tags: - - "tapi-common" - description: "creates or updates tapi.common.NameAndValue" + - "tapi-photonic-media" + summary: "creates or updates tapi.photonic.media.PowerProperties" + description: "This parameter exposes the maximum input power tolerated\r\n \ + \ at the Logical-Termination-Point (LTP) associated to the SIP." parameters: - name: "uuid" in: "path" description: "Id of service-interface-point" required: true type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" + name: "tapi.photonic.media.PowerProperties.body-param" + description: "tapi.photonic.media.PowerProperties to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.photonic.media.PowerProperties" responses: 201: description: "Object created" @@ -11944,29 +12640,28 @@ paths: description: "Object modified" delete: tags: - - "tapi-common" - description: "removes tapi.common.NameAndValue" + - "tapi-photonic-media" + summary: "removes tapi.photonic.media.PowerProperties" + description: "This parameter exposes the maximum input power tolerated\r\n \ + \ at the Logical-Termination-Point (LTP) associated to the SIP." parameters: - name: "uuid" in: "path" description: "Id of service-interface-point" required: true type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/service-interface-point={uuid}/otsi-service-interface-point-spec/: - get: + ? /data/context/service-interface-point={uuid}/otsi-service-interface-point-spec/power-management-capability/tolerable-minimum-input-power/ + : get: tags: - "tapi-photonic-media" - description: "returns tapi.photonic.media.OtsiServiceInterfacePointSpec" + summary: "returns tapi.photonic.media.PowerProperties" + description: "This parameter exposes the minimum input power tolerated\r\n \ + \ at the Logical-Termination-Point (LTP) associated to the SIP." parameters: - name: "uuid" in: "path" @@ -11975,15 +12670,17 @@ paths: type: "string" responses: 200: - description: "tapi.photonic.media.OtsiServiceInterfacePointSpec" + description: "tapi.photonic.media.PowerProperties" schema: - $ref: "#/definitions/tapi.photonic.media.OtsiServiceInterfacePointSpec" + $ref: "#/definitions/tapi.photonic.media.PowerProperties" 400: description: "Internal error" post: tags: - "tapi-photonic-media" - description: "creates tapi.photonic.media.OtsiServiceInterfacePointSpec" + summary: "creates tapi.photonic.media.PowerProperties" + description: "This parameter exposes the minimum input power tolerated\r\n \ + \ at the Logical-Termination-Point (LTP) associated to the SIP." parameters: - name: "uuid" in: "path" @@ -11991,12 +12688,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.photonic.media.OtsiServiceInterfacePointSpec.body-param" - description: "tapi.photonic.media.OtsiServiceInterfacePointSpec to be added\ - \ to list" + name: "tapi.photonic.media.PowerProperties.body-param" + description: "tapi.photonic.media.PowerProperties to be added to list" required: false schema: - $ref: "#/definitions/tapi.photonic.media.OtsiServiceInterfacePointSpec" + $ref: "#/definitions/tapi.photonic.media.PowerProperties" responses: 201: description: "Object created" @@ -12007,7 +12703,9 @@ paths: put: tags: - "tapi-photonic-media" - description: "creates or updates tapi.photonic.media.OtsiServiceInterfacePointSpec" + summary: "creates or updates tapi.photonic.media.PowerProperties" + description: "This parameter exposes the minimum input power tolerated\r\n \ + \ at the Logical-Termination-Point (LTP) associated to the SIP." parameters: - name: "uuid" in: "path" @@ -12015,12 +12713,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.photonic.media.OtsiServiceInterfacePointSpec.body-param" - description: "tapi.photonic.media.OtsiServiceInterfacePointSpec to be added\ - \ or updated" + name: "tapi.photonic.media.PowerProperties.body-param" + description: "tapi.photonic.media.PowerProperties to be added or updated" required: false schema: - $ref: "#/definitions/tapi.photonic.media.OtsiServiceInterfacePointSpec" + $ref: "#/definitions/tapi.photonic.media.PowerProperties" responses: 201: description: "Object created" @@ -12031,7 +12728,9 @@ paths: delete: tags: - "tapi-photonic-media" - description: "removes tapi.photonic.media.OtsiServiceInterfacePointSpec" + summary: "removes tapi.photonic.media.PowerProperties" + description: "This parameter exposes the minimum input power tolerated\r\n \ + \ at the Logical-Termination-Point (LTP) associated to the SIP." parameters: - name: "uuid" in: "path" @@ -12043,11 +12742,13 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/service-interface-point={uuid}/otsi-service-interface-point-spec/otsi-capability/: + /data/context/service-interface-point={uuid}/total-potential-capacity/: get: tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.OtsiCapabilityPac" + - "tapi-common" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" @@ -12056,405 +12757,281 @@ paths: type: "string" responses: 200: - description: "tapi.photonic.media.OtsiCapabilityPac" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.photonic.media.OtsiCapabilityPac" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - ? /data/context/service-interface-point={uuid}/otsi-service-interface-point-spec/otsi-capability/supportable-application-identifier={application-code}/ - : get: + /data/context/service-interface-point={uuid}/total-potential-capacity/total-size/: + get: tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.ApplicationIdentifier" + - "tapi-common" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" description: "Id of service-interface-point" required: true type: "string" - - name: "application-code" - in: "path" - description: "Id of supportable-application-identifier" - required: true - type: "string" responses: 200: - description: "tapi.photonic.media.ApplicationIdentifier" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.photonic.media.ApplicationIdentifier" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/service-interface-point={uuid}/otsi-service-interface-point-spec/otsi-capability/supportable-lower-central-frequency={central-frequency}/ - : get: + /data/context/topology-context/: + get: tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.CentralFrequency" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "central-frequency" - in: "path" - description: "Id of supportable-lower-central-frequency" - required: true - type: "integer" - format: "int32" + - "tapi-topology" + summary: "returns tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: [] responses: 200: - description: "tapi.photonic.media.CentralFrequency" + description: "tapi.topology.TopologyContext" schema: - $ref: "#/definitions/tapi.photonic.media.CentralFrequency" + $ref: "#/definitions/tapi.topology.TopologyContext" 400: description: "Internal error" - ? /data/context/service-interface-point={uuid}/otsi-service-interface-point-spec/otsi-capability/supportable-lower-central-frequency={central-frequency}/frequency-constraint/ - : get: + post: tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.FrequencyConstraint" + - "tapi-topology" + summary: "creates tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "central-frequency" - in: "path" - description: "Id of supportable-lower-central-frequency" - required: true - type: "integer" - format: "int32" + - in: "body" + name: "tapi.topology.context.TopologyContext.body-param" + description: "tapi.topology.TopologyContext to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.topology.TopologyContext" responses: - 200: - description: "tapi.photonic.media.FrequencyConstraint" - schema: - $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" + 201: + description: "Object created" 400: description: "Internal error" - ? /data/context/service-interface-point={uuid}/otsi-service-interface-point-spec/otsi-capability/supportable-upper-central-frequency={central-frequency}/ - : get: + 409: + description: "Object already exists" + put: tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.CentralFrequency" + - "tapi-topology" + summary: "creates or updates tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "central-frequency" - in: "path" - description: "Id of supportable-upper-central-frequency" - required: true - type: "integer" - format: "int32" + - in: "body" + name: "tapi.topology.context.TopologyContext.body-param" + description: "tapi.topology.TopologyContext to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.topology.TopologyContext" responses: - 200: - description: "tapi.photonic.media.CentralFrequency" - schema: - $ref: "#/definitions/tapi.photonic.media.CentralFrequency" + 201: + description: "Object created" 400: description: "Internal error" - ? /data/context/service-interface-point={uuid}/otsi-service-interface-point-spec/otsi-capability/supportable-upper-central-frequency={central-frequency}/frequency-constraint/ - : get: + 204: + description: "Object modified" + delete: tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.FrequencyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "central-frequency" - in: "path" - description: "Id of supportable-upper-central-frequency" - required: true - type: "integer" - format: "int32" + - "tapi-topology" + summary: "removes tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: [] responses: - 200: - description: "tapi.photonic.media.FrequencyConstraint" - schema: - $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" 400: description: "Internal error" - /data/context/service-interface-point={uuid}/otsi-service-interface-point-spec/otsi-capability/total-power-warn-threshold/: + 204: + description: "Object deleted" + /data/context/topology-context/nw-topology-service/: get: tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.TotalPowerThresholdPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" + - "tapi-topology" + summary: "returns tapi.topology.NetworkTopologyService" + description: "none" + parameters: [] responses: 200: - description: "tapi.photonic.media.TotalPowerThresholdPac" + description: "tapi.topology.NetworkTopologyService" schema: - $ref: "#/definitions/tapi.photonic.media.TotalPowerThresholdPac" + $ref: "#/definitions/tapi.topology.NetworkTopologyService" 400: description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/: + /data/context/topology-context/nw-topology-service/name={value-name}/: get: tags: - - "tapi-common" - description: "returns tapi.common.Capacity" + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - - name: "uuid" + - name: "value-name" in: "path" - description: "Id of service-interface-point" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.common.Capacity" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/: + /data/context/topology-context/nw-topology-service/topology={topology-uuid}/: get: tags: - - "tapi-common" - description: "returns tapi.common.BandwidthProfile" + - "tapi-topology" + summary: "returns tapi.topology.TopologyRef" + description: "none" parameters: - - name: "uuid" + - name: "topology-uuid" in: "path" - description: "Id of service-interface-point" + description: "Id of topology" required: true type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.topology.TopologyRef" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.topology.TopologyRef" 400: description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/: + /data/context/topology-context/topology={uuid}/: get: tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" + - "tapi-topology" + summary: "returns tapi.topology.topologycontext.Topology" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of service-interface-point" + description: "Id of topology" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.Topology" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.Topology" 400: description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/: + /data/context/topology-context/topology={uuid}/boundary-node-edge-point={topology-uuid},{node-uuid},{node-edge-point-uuid}/: get: tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of service-interface-point" + description: "Id of topology" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of boundary-node-edge-point" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of boundary-node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of boundary-node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.NodeEdgePointRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: + /data/context/topology-context/topology={uuid}/link={link-uuid}/: get: tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" + - "tapi-topology" + summary: "returns tapi.topology.Link" + description: "none" parameters: - name: "uuid" in: "path" - description: "Id of service-interface-point" + description: "Id of topology" required: true type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" + - name: "link-uuid" in: "path" - description: "Id of service-interface-point" + description: "Id of link" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.Link" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.Link" 400: description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/total-size/: + /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/: get: tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" - description: "Id of service-interface-point" + description: "Id of topology" required: true type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.TopologyContext" - parameters: [] - responses: - 200: - description: "tapi.topology.TopologyContext" - schema: - $ref: "#/definitions/tapi.topology.TopologyContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-topology" - description: "creates tapi.topology.TopologyContext" - parameters: - - in: "body" - name: "tapi.topology.context.TopologyContext.body-param" - description: "tapi.topology.TopologyContext to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.TopologyContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-topology" - description: "creates or updates tapi.topology.TopologyContext" - parameters: - - in: "body" - name: "tapi.topology.context.TopologyContext.body-param" - description: "tapi.topology.TopologyContext to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.TopologyContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-topology" - description: "removes tapi.topology.TopologyContext" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/topology-context/nw-topology-service/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NetworkTopologyService" - parameters: [] - responses: - 200: - description: "tapi.topology.NetworkTopologyService" - schema: - $ref: "#/definitions/tapi.topology.NetworkTopologyService" - 400: - description: "Internal error" - /data/context/topology-context/nw-topology-service/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "value-name" + - name: "link-uuid" in: "path" - description: "Id of name" + description: "Id of link" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - /data/context/topology-context/nw-topology-service/topology={topology-uuid}/: + /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/total-size/: get: tags: - "tapi-topology" - description: "returns tapi.topology.TopologyRef" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - - name: "topology-uuid" + - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Topology" - parameters: - - name: "uuid" + - name: "link-uuid" in: "path" - description: "Id of topology" + description: "Id of link" required: true type: "string" responses: 200: - description: "tapi.topology.Topology" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.topology.Topology" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/: + /data/context/topology-context/topology={uuid}/link={link-uuid}/cost-characteristic={cost-name}/: get: tags: - "tapi-topology" - description: "returns tapi.topology.Link" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" @@ -12466,18 +13043,25 @@ paths: description: "Id of link" required: true type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" responses: 200: - description: "tapi.topology.Link" + description: "tapi.topology.CostCharacteristic" schema: - $ref: "#/definitions/tapi.topology.Link" + $ref: "#/definitions/tapi.topology.CostCharacteristic" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/: + /data/context/topology-context/topology={uuid}/link={link-uuid}/latency-characteristic={traffic-property-name}/: get: tags: - "tapi-topology" - description: "returns tapi.common.Capacity" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" @@ -12489,18 +13073,26 @@ paths: description: "Id of link" required: true type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" responses: 200: - description: "tapi.common.Capacity" + description: "tapi.topology.LatencyCharacteristic" schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/: + /data/context/topology-context/topology={uuid}/link={link-uuid}/name={value-name}/: get: tags: - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -12512,18 +13104,24 @@ paths: description: "Id of link" required: true type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/committed-burst-size/: - get: + ? /data/context/topology-context/topology={uuid}/link={link-uuid}/node-edge-point={topology-uuid},{node-uuid},{node-edge-point-uuid}/ + : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -12535,41 +13133,35 @@ paths: description: "Id of link" required: true type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" + - name: "topology-uuid" in: "path" - description: "Id of topology" + description: "Id of node-edge-point" required: true type: "string" - - name: "link-uuid" + - name: "node-uuid" in: "path" - description: "Id of link" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.NodeEdgePointRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/peak-burst-size/: + /data/context/topology-context/topology={uuid}/link={link-uuid}/risk-characteristic={risk-characteristic-name}/: get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." parameters: - name: "uuid" in: "path" @@ -12581,18 +13173,25 @@ paths: description: "Id of link" required: true type: "string" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-characteristic" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.RiskCharacteristic" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.RiskCharacteristic" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/peak-information-rate/: + /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/: get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" @@ -12606,16 +13205,18 @@ paths: type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/total-size/: + /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/total-size/: get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -12634,11 +13235,13 @@ paths: $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/cost-characteristic={cost-name}/: + /data/context/topology-context/topology={uuid}/link={link-uuid}/validation-mechanism={validation-mechanism}/: get: tags: - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" + summary: "returns tapi.topology.ValidationMechanism" + description: "Provides details of the specific validation mechanism(s) used\ + \ to confirm the presence of an intended topologicalEntity." parameters: - name: "uuid" in: "path" @@ -12650,103 +13253,98 @@ paths: description: "Id of link" required: true type: "string" - - name: "cost-name" + - name: "validation-mechanism" in: "path" - description: "Id of cost-characteristic" + description: "Id of validation-mechanism" required: true type: "string" responses: 200: - description: "tapi.topology.CostCharacteristic" + description: "tapi.topology.ValidationMechanism" schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" + $ref: "#/definitions/tapi.topology.ValidationMechanism" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/latency-characteristic={traffic-property-name}/: + /data/context/topology-context/topology={uuid}/name={value-name}/: get: tags: - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "traffic-property-name" + - name: "value-name" in: "path" - description: "Id of latency-characteristic" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.topology.LatencyCharacteristic" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/name={value-name}/: + /data/context/topology-context/topology={uuid}/node={node-uuid}/: get: tags: - "tapi-topology" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.topology.topology.Node" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "value-name" + - name: "node-uuid" in: "path" - description: "Id of name" + description: "Id of node" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.topology.topology.Node" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.topology.topology.Node" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/node-edge-point={topology-uuid},{node-uuid},{node-edge-point-uuid}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ : get: tags: - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "link-uuid" + - name: "node-uuid" in: "path" - description: "Id of link" + description: "Id of node" required: true type: "string" - name: "topology-uuid" in: "path" - description: "Id of node-edge-point" + description: "Id of aggregated-node-edge-point" required: true type: "string" - - name: "node-uuid" + - name: "aggregated-node-edge-point-node-uuid" in: "path" - description: "Id of node-edge-point" + description: "Id of aggregated-node-edge-point" required: true type: "string" - name: "node-edge-point-uuid" in: "path" - description: "Id of node-edge-point" + description: "Id of aggregated-node-edge-point" required: true type: "string" responses: @@ -12756,71 +13354,21 @@ paths: $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/resilience-type/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.ResilienceType" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.ResilienceType" - schema: - $ref: "#/definitions/tapi.topology.ResilienceType" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/risk-characteristic={risk-characteristic-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/: + /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/: get: tags: - "tapi-topology" - description: "returns tapi.common.Capacity" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "link-uuid" + - name: "node-uuid" in: "path" - description: "Id of link" + description: "Id of node" required: true type: "string" responses: @@ -12830,66 +13378,22 @@ paths: $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/: + /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/total-size/: get: tags: - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "link-uuid" + - name: "node-uuid" in: "path" - description: "Id of link" + description: "Id of node" required: true type: "string" responses: @@ -12899,114 +13403,109 @@ paths: $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: + /data/context/topology-context/topology={uuid}/node={node-uuid}/cost-characteristic={cost-name}/: get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" + - name: "node-uuid" in: "path" - description: "Id of topology" + description: "Id of node" required: true type: "string" - - name: "link-uuid" + - name: "cost-name" in: "path" - description: "Id of link" + description: "Id of cost-characteristic" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.CostCharacteristic" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.CostCharacteristic" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/total-size/: + /data/context/topology-context/topology={uuid}/node={node-uuid}/encap-topology/: get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.TopologyRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "link-uuid" + - name: "node-uuid" in: "path" - description: "Id of link" + description: "Id of node" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.TopologyRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.TopologyRef" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/validation-mechanism={validation-mechanism}/: + /data/context/topology-context/topology={uuid}/node={node-uuid}/latency-characteristic={traffic-property-name}/: get: tags: - "tapi-topology" - description: "returns tapi.topology.ValidationMechanism" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "link-uuid" + - name: "node-uuid" in: "path" - description: "Id of link" + description: "Id of node" required: true type: "string" - - name: "validation-mechanism" + - name: "traffic-property-name" in: "path" - description: "Id of validation-mechanism" + description: "Id of latency-characteristic" required: true type: "string" responses: 200: - description: "tapi.topology.ValidationMechanism" + description: "tapi.topology.LatencyCharacteristic" schema: - $ref: "#/definitions/tapi.topology.ValidationMechanism" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/name={value-name}/: + /data/context/topology-context/topology={uuid}/node={node-uuid}/name={value-name}/: get: tags: - "tapi-topology" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" - name: "value-name" in: "path" description: "Id of name" @@ -13019,11 +13518,12 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/: get: tags: - "tapi-topology" - description: "returns tapi.topology.topology.Node" + summary: "returns tapi.topology.node.NodeEdgePoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -13035,18 +13535,24 @@ paths: description: "Id of node" required: true type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" responses: 200: - description: "tapi.topology.topology.Node" + description: "tapi.topology.node.NodeEdgePoint" schema: - $ref: "#/definitions/tapi.topology.topology.Node" + $ref: "#/definitions/tapi.topology.node.NodeEdgePoint" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{aggregated-node-edge-point-node-edge-point-uuid}/ : get: tags: - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -13058,6 +13564,11 @@ paths: description: "Id of node" required: true type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" - name: "topology-uuid" in: "path" description: "Id of aggregated-node-edge-point" @@ -13068,7 +13579,7 @@ paths: description: "Id of aggregated-node-edge-point" required: true type: "string" - - name: "node-edge-point-uuid" + - name: "aggregated-node-edge-point-node-edge-point-uuid" in: "path" description: "Id of aggregated-node-edge-point" required: true @@ -13080,11 +13591,12 @@ paths: $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-capacity/: get: tags: - "tapi-topology" - description: "returns tapi.common.Capacity" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" @@ -13096,6 +13608,11 @@ paths: description: "Id of node" required: true type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" responses: 200: description: "tapi.common.Capacity" @@ -13103,11 +13620,13 @@ paths: $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/: - get: + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-capacity/total-size/ + : get: tags: - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -13119,18 +13638,24 @@ paths: description: "Id of node" required: true type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/committed-burst-size/: - get: + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-cep-layer-protocol={layer-protocol-qualifier}/ + : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.NepLayerProtocolCapability" + description: "none" parameters: - name: "uuid" in: "path" @@ -13142,18 +13667,29 @@ paths: description: "Id of node" required: true type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "layer-protocol-qualifier" + in: "path" + description: "Id of available-cep-layer-protocol" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.NepLayerProtocolCapability" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.NepLayerProtocolCapability" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/: + get: tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" + - "tapi-connectivity" + summary: "returns tapi.connectivity.context.topologycontext.topology.node.nodeedgepoint.CepList" + description: "none" parameters: - name: "uuid" in: "path" @@ -13165,18 +13701,24 @@ paths: description: "Id of node" required: true type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.connectivity.context.topologycontext.topology.node.nodeedgepoint.CepList" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.connectivity.context.topologycontext.topology.node.nodeedgepoint.CepList" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/peak-burst-size/: - get: + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/ + : get: tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" + - "tapi-connectivity" + summary: "returns tapi.connectivity.ceplist.ConnectionEndPoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -13188,18 +13730,29 @@ paths: description: "Id of node" required: true type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.connectivity.ceplist.ConnectionEndPoint" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.connectivity.ceplist.ConnectionEndPoint" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/peak-information-rate/: - get: + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/aggregated-connection-end-point={topology-uuid},{aggregated-connection-end-point-node-uuid},{aggregated-connection-end-point-node-edge-point-uuid},{aggregated-connection-end-point-connection-end-point-uuid}/ + : get: tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" + - "tapi-connectivity" + summary: "returns tapi.connectivity.ConnectionEndPointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -13211,69 +13764,49 @@ paths: description: "Id of node" required: true type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of topology" + description: "Id of node-edge-point" required: true type: "string" - - name: "node-uuid" + - name: "connection-end-point-uuid" in: "path" - description: "Id of node" + description: "Id of connection-end-point" required: true type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" + - name: "topology-uuid" in: "path" - description: "Id of topology" + description: "Id of aggregated-connection-end-point" required: true type: "string" - - name: "node-uuid" + - name: "aggregated-connection-end-point-node-uuid" in: "path" - description: "Id of node" + description: "Id of aggregated-connection-end-point" required: true type: "string" - - name: "cost-name" + - name: "aggregated-connection-end-point-node-edge-point-uuid" in: "path" - description: "Id of cost-characteristic" + description: "Id of aggregated-connection-end-point" + required: true + type: "string" + - name: "aggregated-connection-end-point-connection-end-point-uuid" + in: "path" + description: "Id of aggregated-connection-end-point" required: true type: "string" responses: 200: - description: "tapi.topology.CostCharacteristic" + description: "tapi.connectivity.ConnectionEndPointRef" schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" + $ref: "#/definitions/tapi.connectivity.ConnectionEndPointRef" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/encap-topology/: - get: + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/client-node-edge-point={topology-uuid},{client-node-edge-point-node-uuid},{client-node-edge-point-node-edge-point-uuid}/ + : get: tags: - - "tapi-topology" - description: "returns tapi.topology.TopologyRef" + - "tapi-connectivity" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -13285,46 +13818,44 @@ paths: description: "Id of node" required: true type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/latency-characteristic={traffic-property-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of topology" + description: "Id of node-edge-point" required: true type: "string" - - name: "node-uuid" + - name: "connection-end-point-uuid" in: "path" - description: "Id of node" + description: "Id of connection-end-point" required: true type: "string" - - name: "traffic-property-name" + - name: "topology-uuid" in: "path" - description: "Id of latency-characteristic" + description: "Id of client-node-edge-point" + required: true + type: "string" + - name: "client-node-edge-point-node-uuid" + in: "path" + description: "Id of client-node-edge-point" + required: true + type: "string" + - name: "client-node-edge-point-node-edge-point-uuid" + in: "path" + description: "Id of client-node-edge-point" required: true type: "string" responses: 200: - description: "tapi.topology.LatencyCharacteristic" + description: "tapi.topology.NodeEdgePointRef" schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/name={value-name}/: - get: + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/media-channel-connection-end-point-spec/ + : get: tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.MediaChannelConnectionEndPointSpec" + description: "none" parameters: - name: "uuid" in: "path" @@ -13336,23 +13867,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "value-name" + - name: "node-edge-point-uuid" in: "path" - description: "Id of name" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.photonic.media.MediaChannelConnectionEndPointSpec" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.photonic.media.MediaChannelConnectionEndPointSpec" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/: - get: + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/media-channel-connection-end-point-spec/media-channel/ + : get: tags: - - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroup" + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.MediaChannelPropertiesPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -13364,23 +13901,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.topology.NodeRuleGroup" + description: "tapi.photonic.media.MediaChannelPropertiesPac" schema: - $ref: "#/definitions/tapi.topology.NodeRuleGroup" + $ref: "#/definitions/tapi.photonic.media.MediaChannelPropertiesPac" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/: - get: + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/media-channel-connection-end-point-spec/media-channel/measured-power-egress/ + : get: tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.PowerProperties" + description: "none" parameters: - name: "uuid" in: "path" @@ -13392,23 +13935,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.common.Capacity" + description: "tapi.photonic.media.PowerProperties" schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.photonic.media.PowerProperties" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/media-channel-connection-end-point-spec/media-channel/measured-power-ingress/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.PowerProperties" + description: "none" parameters: - name: "uuid" in: "path" @@ -13420,23 +13969,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.photonic.media.PowerProperties" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.photonic.media.PowerProperties" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/media-channel-connection-end-point-spec/media-channel/occupied-spectrum/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.SpectrumBand" + description: "none" parameters: - name: "uuid" in: "path" @@ -13448,23 +14003,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.photonic.media.SpectrumBand" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.photonic.media.SpectrumBand" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/media-channel-connection-end-point-spec/media-channel/occupied-spectrum/frequency-constraint/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.FrequencyConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -13476,23 +14037,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.photonic.media.FrequencyConstraint" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" + - "tapi-oam" + summary: "returns tapi.oam.MepMipList" + description: "none" parameters: - name: "uuid" in: "path" @@ -13504,23 +14071,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.oam.MepMipList" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.oam.MepMipList" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/mep={meg-uuid},{mep-local-id}/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" + - "tapi-oam" + summary: "returns tapi.oam.MepRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -13532,51 +14105,39 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" + - name: "connection-end-point-uuid" in: "path" - description: "Id of topology" + description: "Id of connection-end-point" required: true type: "string" - - name: "node-uuid" + - name: "meg-uuid" in: "path" - description: "Id of node" + description: "Id of mep" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "mep-local-id" in: "path" - description: "Id of node-rule-group" + description: "Id of mep" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.oam.MepRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.oam.MepRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/composed-rule-group={topology-uuid},{composed-rule-group-node-uuid},{composed-rule-group-node-rule-group-uuid}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/mip={meg-uuid},{mip-local-id}/ : get: tags: - - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroupRef" + - "tapi-oam" + summary: "returns tapi.oam.MipRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -13588,38 +14149,41 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "topology-uuid" + - name: "connection-end-point-uuid" in: "path" - description: "Id of composed-rule-group" + description: "Id of connection-end-point" required: true type: "string" - - name: "composed-rule-group-node-uuid" + - name: "meg-uuid" in: "path" - description: "Id of composed-rule-group" + description: "Id of mip" required: true type: "string" - - name: "composed-rule-group-node-rule-group-uuid" + - name: "mip-local-id" in: "path" - description: "Id of composed-rule-group" + description: "Id of mip" required: true type: "string" responses: 200: - description: "tapi.topology.NodeRuleGroupRef" + description: "tapi.oam.MipRef" schema: - $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + $ref: "#/definitions/tapi.oam.MipRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/cost-characteristic={cost-name}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/name={value-name}/ : get: tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" + - "tapi-connectivity" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -13631,28 +14195,34 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "cost-name" + - name: "connection-end-point-uuid" in: "path" - description: "Id of cost-characteristic" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.topology.CostCharacteristic" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/odu-connection-end-point-spec/ : get: tags: - - "tapi-topology" - description: "returns tapi.topology.InterRuleGroup" + - "tapi-odu" + summary: "returns tapi.odu.OduConnectionEndPointSpec" + description: "none" parameters: - name: "uuid" in: "path" @@ -13664,28 +14234,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "connection-end-point-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.topology.InterRuleGroup" + description: "tapi.odu.OduConnectionEndPointSpec" schema: - $ref: "#/definitions/tapi.topology.InterRuleGroup" + $ref: "#/definitions/tapi.odu.OduConnectionEndPointSpec" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/associated-node-rule-group={topology-uuid},{associated-node-rule-group-node-uuid},{associated-node-rule-group-node-rule-group-uuid}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/odu-connection-end-point-spec/odu-common/ : get: tags: - - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroupRef" + - "tapi-odu" + summary: "returns tapi.odu.OduCommonPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -13697,43 +14268,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of associated-node-rule-group" - required: true - type: "string" - - name: "associated-node-rule-group-node-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of associated-node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "associated-node-rule-group-node-rule-group-uuid" + - name: "connection-end-point-uuid" in: "path" - description: "Id of associated-node-rule-group" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.topology.NodeRuleGroupRef" + description: "tapi.odu.OduCommonPac" schema: - $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + $ref: "#/definitions/tapi.odu.OduCommonPac" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/odu-connection-end-point-spec/odu-ctp/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" + - "tapi-odu" + summary: "returns tapi.odu.OduCtpPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -13745,28 +14302,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "connection-end-point-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.common.Capacity" + description: "tapi.odu.OduCtpPac" schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.odu.OduCtpPac" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/odu-connection-end-point-spec/odu-protection/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" + - "tapi-odu" + summary: "returns tapi.odu.OduProtectionPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -13778,28 +14336,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "connection-end-point-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.odu.OduProtectionPac" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.odu.OduProtectionPac" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/odu-connection-end-point-spec/odu-term-and-adapter/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" + - "tapi-odu" + summary: "returns tapi.odu.OduTerminationAndClientAdaptationPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -13811,28 +14370,34 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "connection-end-point-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.odu.OduTerminationAndClientAdaptationPac" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.odu.OduTerminationAndClientAdaptationPac" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/odu-connection-end-point-spec/odu-term-and-adapter/accepted-payload-type/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" + - "tapi-odu" + summary: "returns tapi.odu.OduPayloadType" + description: "This attribute is applicable when the ODU CTP object instance\ + \ represents a lower order ODU CTP Sink at the client layer of the ODUP/ODU[i]j\ + \ or ODUP/ODUj-21 adaptation function. \r\n This attribute\ + \ is a 2-digit Hex code that indicates the new accepted payload type.\r\n\ + \ Valid values are defined in Table 15-8 of ITU-T Recommendation\ + \ G.709 with one additional value UN_INTERPRETABLE." parameters: - name: "uuid" in: "path" @@ -13844,28 +14409,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "connection-end-point-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.odu.OduPayloadType" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.odu.OduPayloadType" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/otsi-assembly-connection-end-point-spec/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.OtsiAssemblyConnectionEndPointSpec" + description: "none" parameters: - name: "uuid" in: "path" @@ -13877,28 +14443,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "connection-end-point-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.photonic.media.OtsiAssemblyConnectionEndPointSpec" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.photonic.media.OtsiAssemblyConnectionEndPointSpec" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/otsi-assembly-connection-end-point-spec/otsi-adapter/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.OtsiServerAdaptationPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -13910,28 +14477,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "connection-end-point-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.photonic.media.OtsiServerAdaptationPac" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.photonic.media.OtsiServerAdaptationPac" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/total-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/otsi-assembly-connection-end-point-spec/otsi-adapter/fec-parameters/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.FecProperties" + description: "none" parameters: - name: "uuid" in: "path" @@ -13943,28 +14511,30 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "connection-end-point-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.photonic.media.FecProperties" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.photonic.media.FecProperties" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/cost-characteristic={cost-name}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/otsi-connection-end-point-spec/ : get: tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.OtsiConnectionEndPointSpec" + description: "Augments the base LayerProtocol information in ConnectionEndPoint\ + \ with OCH-specific information" parameters: - name: "uuid" in: "path" @@ -13976,33 +14546,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "cost-name" + - name: "connection-end-point-uuid" in: "path" - description: "Id of cost-characteristic" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.topology.CostCharacteristic" + description: "tapi.photonic.media.OtsiConnectionEndPointSpec" schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" + $ref: "#/definitions/tapi.photonic.media.OtsiConnectionEndPointSpec" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/latency-characteristic={traffic-property-name}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/otsi-connection-end-point-spec/otsi-termination/ : get: tags: - - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.OtsiTerminationPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -14014,33 +14580,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "traffic-property-name" + - name: "connection-end-point-uuid" in: "path" - description: "Id of latency-characteristic" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.topology.LatencyCharacteristic" + description: "tapi.photonic.media.OtsiTerminationPac" schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + $ref: "#/definitions/tapi.photonic.media.OtsiTerminationPac" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/name={value-name}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/otsi-connection-end-point-spec/otsi-termination/laser-properties/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.LaserProperties" + description: "Laser properties." parameters: - name: "uuid" in: "path" @@ -14052,33 +14614,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "value-name" + - name: "connection-end-point-uuid" in: "path" - description: "Id of name" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.photonic.media.LaserProperties" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.photonic.media.LaserProperties" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/otsi-connection-end-point-spec/otsi-termination/received-power/ : get: tags: - - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.PowerProperties" + description: "none" parameters: - name: "uuid" in: "path" @@ -14090,33 +14648,45 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "risk-characteristic-name" + - name: "connection-end-point-uuid" in: "path" - description: "Id of risk-characteristic" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.topology.RiskCharacteristic" + description: "tapi.photonic.media.PowerProperties" schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" + $ref: "#/definitions/tapi.photonic.media.PowerProperties" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/otsi-connection-end-point-spec/otsi-termination/selected-application-identifier/ : get: tags: - - "tapi-topology" - description: "returns tapi.topology.Rule" + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.ApplicationIdentifier" + description: "This attribute indicates the selected Application Identifier that\ + \ is used by the OCh trail termination function. The syntax of ApplicationIdentifier\ + \ is a pair {ApplicationIdentifierType, PrintableString}. The value of ApplicationIdentifierType\ + \ is either STANDARD or PROPRIETARY. The value of PrintableString represents\ + \ the standard application code as defined in the ITU-T Recommendations or\ + \ a vendor-specific proprietary code. If the ApplicationIdentifierType is\ + \ STANDARD the value of PrintableString represents a standard application\ + \ code as defined in the ITU-T Recommendations. If the ApplicationIdentifierType\ + \ is PROPRIETARY, the first six characters of the PrintableString must contain\ + \ the Hexadecimal representation of an OUI assigned to the vendor whose implementation\ + \ generated the Application Identifier; the remaining octets of the PrintableString\ + \ are unspecified. The value of this attribute of an object instance has to\ + \ be one of the values identified in the attribute SupportableApplicationIdentifierList\ + \ of the same object instance. The values and value ranges of the optical\ + \ interface parameters of a standard application code must be consistent with\ + \ those values specified in the ITU-T Recommendation for that application\ + \ code." parameters: - name: "uuid" in: "path" @@ -14128,33 +14698,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "local-id" + - name: "connection-end-point-uuid" in: "path" - description: "Id of rule" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.topology.Rule" + description: "tapi.photonic.media.ApplicationIdentifier" schema: - $ref: "#/definitions/tapi.topology.Rule" + $ref: "#/definitions/tapi.photonic.media.ApplicationIdentifier" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/name={value-name}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/otsi-connection-end-point-spec/otsi-termination/selected-central-frequency/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.CentralFrequency" + description: "none" parameters: - name: "uuid" in: "path" @@ -14166,38 +14732,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "local-id" + - name: "node-edge-point-uuid" in: "path" - description: "Id of rule" + description: "Id of node-edge-point" required: true type: "string" - - name: "value-name" + - name: "connection-end-point-uuid" in: "path" - description: "Id of name" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.photonic.media.CentralFrequency" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.photonic.media.CentralFrequency" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/otsi-connection-end-point-spec/otsi-termination/selected-central-frequency/frequency-constraint/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.FrequencyConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -14209,28 +14766,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "connection-end-point-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.common.Capacity" + description: "tapi.photonic.media.FrequencyConstraint" schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/otsi-connection-end-point-spec/otsi-termination/selected-spectrum/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.SpectrumBand" + description: "none" parameters: - name: "uuid" in: "path" @@ -14242,28 +14800,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "connection-end-point-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.photonic.media.SpectrumBand" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.photonic.media.SpectrumBand" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/otsi-connection-end-point-spec/otsi-termination/selected-spectrum/frequency-constraint/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.FrequencyConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -14275,28 +14834,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "connection-end-point-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.photonic.media.FrequencyConstraint" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/otsi-connection-end-point-spec/otsi-termination/transmited-power/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.PowerProperties" + description: "Measured power at the Transmitter." parameters: - name: "uuid" in: "path" @@ -14308,28 +14868,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "connection-end-point-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.photonic.media.PowerProperties" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.photonic.media.PowerProperties" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/parent-node-edge-point/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" + - "tapi-connectivity" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -14341,28 +14902,31 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "connection-end-point-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of connection-end-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.NodeEdgePointRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/mapped-service-interface-point={service-interface-point-uuid}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "NodeEdgePoint mapped to more than ServiceInterfacePoint (slicing/virtualizing)\ + \ or a ServiceInterfacePoint mapped to more than one NodeEdgePoint (load balancing/Resilience)\ + \ should be considered experimental" parameters: - name: "uuid" in: "path" @@ -14374,28 +14938,30 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "service-interface-point-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of mapped-service-interface-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.ServiceInterfacePointRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/total-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/media-channel-node-edge-point-spec/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.MediaChannelNodeEdgePointSpec" + description: "Augments the base LayerProtocol information in NodeEdgePoint with\ + \ OCH-specific information" parameters: - name: "uuid" in: "path" @@ -14407,28 +14973,24 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.photonic.media.MediaChannelNodeEdgePointSpec" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.photonic.media.MediaChannelNodeEdgePointSpec" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/latency-characteristic={traffic-property-name}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/media-channel-node-edge-point-spec/mc-pool/ : get: tags: - - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.MediaChannelPoolCapabilityPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -14440,28 +15002,24 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "traffic-property-name" + - name: "node-edge-point-uuid" in: "path" - description: "Id of latency-characteristic" + description: "Id of node-edge-point" required: true type: "string" responses: 200: - description: "tapi.topology.LatencyCharacteristic" + description: "tapi.photonic.media.MediaChannelPoolCapabilityPac" schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + $ref: "#/definitions/tapi.photonic.media.MediaChannelPoolCapabilityPac" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/name={value-name}/: - get: + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/media-channel-node-edge-point-spec/mc-pool/available-spectrum={upper-frequency},{lower-frequency}/ + : get: tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.SpectrumBand" + description: "none" parameters: - name: "uuid" in: "path" @@ -14473,28 +15031,36 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "value-name" + - name: "upper-frequency" in: "path" - description: "Id of name" + description: "Id of available-spectrum" required: true - type: "string" + type: "integer" + format: "int32" + - name: "lower-frequency" + in: "path" + description: "Id of available-spectrum" + required: true + type: "integer" + format: "int32" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.photonic.media.SpectrumBand" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.photonic.media.SpectrumBand" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/node-edge-point={topology-uuid},{node-edge-point-node-uuid},{node-edge-point-uuid}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/media-channel-node-edge-point-spec/mc-pool/available-spectrum={upper-frequency},{lower-frequency}/frequency-constraint/ : get: tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.FrequencyConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -14506,38 +15072,36 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "topology-uuid" + - name: "node-edge-point-uuid" in: "path" description: "Id of node-edge-point" required: true type: "string" - - name: "node-edge-point-node-uuid" + - name: "upper-frequency" in: "path" - description: "Id of node-edge-point" + description: "Id of available-spectrum" required: true - type: "string" - - name: "node-edge-point-uuid" + type: "integer" + format: "int32" + - name: "lower-frequency" in: "path" - description: "Id of node-edge-point" + description: "Id of available-spectrum" required: true - type: "string" + type: "integer" + format: "int32" responses: 200: - description: "tapi.topology.NodeEdgePointRef" + description: "tapi.photonic.media.FrequencyConstraint" schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/media-channel-node-edge-point-spec/mc-pool/occupied-spectrum={upper-frequency},{lower-frequency}/ : get: tags: - - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.SpectrumBand" + description: "none" parameters: - name: "uuid" in: "path" @@ -14549,28 +15113,36 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "risk-characteristic-name" + - name: "upper-frequency" in: "path" - description: "Id of risk-characteristic" + description: "Id of occupied-spectrum" required: true - type: "string" + type: "integer" + format: "int32" + - name: "lower-frequency" + in: "path" + description: "Id of occupied-spectrum" + required: true + type: "integer" + format: "int32" responses: 200: - description: "tapi.topology.RiskCharacteristic" + description: "tapi.photonic.media.SpectrumBand" schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" + $ref: "#/definitions/tapi.photonic.media.SpectrumBand" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/: - get: + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/media-channel-node-edge-point-spec/mc-pool/occupied-spectrum={upper-frequency},{lower-frequency}/frequency-constraint/ + : get: tags: - - "tapi-topology" - description: "returns tapi.topology.Rule" + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.FrequencyConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -14582,28 +15154,36 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "local-id" + - name: "upper-frequency" in: "path" - description: "Id of rule" + description: "Id of occupied-spectrum" required: true - type: "string" + type: "integer" + format: "int32" + - name: "lower-frequency" + in: "path" + description: "Id of occupied-spectrum" + required: true + type: "integer" + format: "int32" responses: 200: - description: "tapi.topology.Rule" + description: "tapi.photonic.media.FrequencyConstraint" schema: - $ref: "#/definitions/tapi.topology.Rule" + $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/name={value-name}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/media-channel-node-edge-point-spec/mc-pool/supportable-spectrum={upper-frequency},{lower-frequency}/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.SpectrumBand" + description: "none" parameters: - name: "uuid" in: "path" @@ -14615,33 +15195,79 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "local-id" + - name: "upper-frequency" in: "path" - description: "Id of rule" + description: "Id of supportable-spectrum" + required: true + type: "integer" + format: "int32" + - name: "lower-frequency" + in: "path" + description: "Id of supportable-spectrum" + required: true + type: "integer" + format: "int32" + responses: + 200: + description: "tapi.photonic.media.SpectrumBand" + schema: + $ref: "#/definitions/tapi.photonic.media.SpectrumBand" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/media-channel-node-edge-point-spec/mc-pool/supportable-spectrum={upper-frequency},{lower-frequency}/frequency-constraint/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.FrequencyConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" required: true type: "string" - - name: "value-name" + - name: "node-uuid" in: "path" - description: "Id of name" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" required: true type: "string" + - name: "upper-frequency" + in: "path" + description: "Id of supportable-spectrum" + required: true + type: "integer" + format: "int32" + - name: "lower-frequency" + in: "path" + description: "Id of supportable-spectrum" + required: true + type: "integer" + format: "int32" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.photonic.media.FrequencyConstraint" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/name={value-name}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.Capacity" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -14653,23 +15279,30 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.common.Capacity" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/odu-node-edge-point-spec/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" + - "tapi-odu" + summary: "returns tapi.odu.OduNodeEdgePointSpec" + description: "Augments the base LayerProtocol information in NodeEdgePoint with\ + \ ODU-specific information" parameters: - name: "uuid" in: "path" @@ -14681,23 +15314,24 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.odu.OduNodeEdgePointSpec" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.odu.OduNodeEdgePointSpec" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/odu-node-edge-point-spec/odu-pool/ : get: tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" + - "tapi-odu" + summary: "returns tapi.odu.OduPoolPac" + description: "none" parameters: - name: "uuid" in: "path" @@ -14709,23 +15343,25 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.odu.OduPoolPac" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.odu.OduPoolPac" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/total-potential-capacity/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" @@ -14737,23 +15373,25 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/total-potential-capacity/total-size/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -14765,9 +15403,9 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" responses: @@ -14777,11 +15415,12 @@ paths: $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.NodeRuleGroup" + description: "none" parameters: - name: "uuid" in: "path" @@ -14800,16 +15439,17 @@ paths: type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.NodeRuleGroup" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.NodeRuleGroup" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/total-size/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" @@ -14828,16 +15468,18 @@ paths: type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/: - get: + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/total-size/ + : get: tags: - "tapi-topology" - description: "returns tapi.topology.node.OwnedNodeEdgePoint" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -14849,23 +15491,24 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-rule-group" required: true type: "string" responses: 200: - description: "tapi.topology.node.OwnedNodeEdgePoint" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.topology.node.OwnedNodeEdgePoint" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/composed-rule-group={topology-uuid},{composed-rule-group-node-uuid},{composed-rule-group-node-rule-group-uuid}/ : get: tags: - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" + summary: "returns tapi.topology.NodeRuleGroupRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -14877,38 +15520,40 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-rule-group" required: true type: "string" - name: "topology-uuid" in: "path" - description: "Id of aggregated-node-edge-point" + description: "Id of composed-rule-group" required: true type: "string" - - name: "aggregated-node-edge-point-node-uuid" + - name: "composed-rule-group-node-uuid" in: "path" - description: "Id of aggregated-node-edge-point" + description: "Id of composed-rule-group" required: true type: "string" - - name: "node-edge-point-uuid" + - name: "composed-rule-group-node-rule-group-uuid" in: "path" - description: "Id of aggregated-node-edge-point" + description: "Id of composed-rule-group" required: true type: "string" responses: 200: - description: "tapi.topology.NodeEdgePointRef" + description: "tapi.topology.NodeRuleGroupRef" schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/cost-characteristic={cost-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.Capacity" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" @@ -14920,23 +15565,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "cost-name" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of cost-characteristic" required: true type: "string" responses: 200: - description: "tapi.common.Capacity" + description: "tapi.topology.CostCharacteristic" schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.topology.CostCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" + summary: "returns tapi.topology.InterRuleGroup" + description: "none" parameters: - name: "uuid" in: "path" @@ -14948,23 +15599,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of inter-rule-group" required: true type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.topology.InterRuleGroup" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.topology.InterRuleGroup" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/associated-node-rule-group={topology-uuid},{associated-node-rule-group-node-uuid},{associated-node-rule-group-node-rule-group-uuid}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.NodeRuleGroupRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -14976,23 +15633,44 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of associated-node-rule-group" + required: true + type: "string" + - name: "associated-node-rule-group-node-uuid" + in: "path" + description: "Id of associated-node-rule-group" + required: true + type: "string" + - name: "associated-node-rule-group-node-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of associated-node-rule-group" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.NodeRuleGroupRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" @@ -15004,23 +15682,30 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of inter-rule-group" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/total-size/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -15032,9 +15717,14 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of inter-rule-group" required: true type: "string" responses: @@ -15044,11 +15734,13 @@ paths: $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/cost-characteristic={cost-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" @@ -15060,23 +15752,35 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "cost-name" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of cost-characteristic" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.CostCharacteristic" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.CostCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/total-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/latency-characteristic={traffic-property-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" @@ -15088,51 +15792,36 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-rule-group" required: true type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.context.topologycontext.topology.node.ownednodeedgepoint.CepList" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of node" + description: "Id of inter-rule-group" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "traffic-property-name" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of latency-characteristic" required: true type: "string" responses: 200: - description: "tapi.connectivity.context.topologycontext.topology.node.ownednodeedgepoint.CepList" + description: "tapi.topology.LatencyCharacteristic" schema: - $ref: "#/definitions/tapi.connectivity.context.topologycontext.topology.node.ownednodeedgepoint.CepList" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/name={value-name}/ : get: tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ceplist.ConnectionEndPoint" + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -15144,28 +15833,35 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-rule-group" required: true type: "string" - - name: "connection-end-point-uuid" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of connection-end-point" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.connectivity.ceplist.ConnectionEndPoint" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.connectivity.ceplist.ConnectionEndPoint" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/aggregated-connection-end-point={topology-uuid},{aggregated-connection-end-point-node-uuid},{node-edge-point-uuid},{aggregated-connection-end-point-connection-end-point-uuid}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ : get: tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionEndPointRef" + - "tapi-topology" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." parameters: - name: "uuid" in: "path" @@ -15177,48 +15873,34 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of aggregated-connection-end-point" - required: true - type: "string" - - name: "aggregated-connection-end-point-node-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of aggregated-connection-end-point" + description: "Id of node-rule-group" required: true type: "string" - - name: "node-edge-point-uuid" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of aggregated-connection-end-point" + description: "Id of inter-rule-group" required: true type: "string" - - name: "aggregated-connection-end-point-connection-end-point-uuid" + - name: "risk-characteristic-name" in: "path" - description: "Id of aggregated-connection-end-point" + description: "Id of risk-characteristic" required: true type: "string" responses: 200: - description: "tapi.connectivity.ConnectionEndPointRef" + description: "tapi.topology.RiskCharacteristic" schema: - $ref: "#/definitions/tapi.connectivity.ConnectionEndPointRef" + $ref: "#/definitions/tapi.topology.RiskCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/client-node-edge-point={topology-uuid},{client-node-edge-point-node-uuid},{node-edge-point-uuid}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/ : get: tags: - - "tapi-connectivity" - description: "returns tapi.topology.NodeEdgePointRef" + - "tapi-topology" + summary: "returns tapi.topology.Rule" + description: "none" parameters: - name: "uuid" in: "path" @@ -15230,43 +15912,36 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "topology-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of client-node-edge-point" + description: "Id of node-rule-group" required: true type: "string" - - name: "client-node-edge-point-node-uuid" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of client-node-edge-point" + description: "Id of inter-rule-group" required: true type: "string" - - name: "node-edge-point-uuid" + - name: "local-id" in: "path" - description: "Id of client-node-edge-point" + description: "Id of rule" required: true type: "string" responses: 200: - description: "tapi.topology.NodeEdgePointRef" + description: "tapi.topology.Rule" schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + $ref: "#/definitions/tapi.topology.Rule" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/media-channel-assembly-spec/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/name={value-name}/ : get: tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.MediaChannelAssemblySpec" + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -15278,28 +15953,40 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of inter-rule-group" required: true type: "string" - - name: "connection-end-point-uuid" + - name: "local-id" in: "path" - description: "Id of connection-end-point" + description: "Id of rule" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.photonic.media.MediaChannelAssemblySpec" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.photonic.media.MediaChannelAssemblySpec" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/media-channel-connection-end-point-spec/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/ : get: tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.MediaChannelConnectionEndPointSpec" + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" @@ -15311,28 +15998,30 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-rule-group" required: true type: "string" - - name: "connection-end-point-uuid" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of connection-end-point" + description: "Id of inter-rule-group" required: true type: "string" responses: 200: - description: "tapi.photonic.media.MediaChannelConnectionEndPointSpec" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.photonic.media.MediaChannelConnectionEndPointSpec" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/media-channel-connection-end-point-spec/media-channel/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/total-size/ : get: tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.MediaChannelPropertiesPac" + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -15344,28 +16033,30 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-rule-group" required: true type: "string" - - name: "connection-end-point-uuid" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of connection-end-point" + description: "Id of inter-rule-group" required: true type: "string" responses: 200: - description: "tapi.photonic.media.MediaChannelPropertiesPac" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.photonic.media.MediaChannelPropertiesPac" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/media-channel-connection-end-point-spec/media-channel/measured-power-egress/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/latency-characteristic={traffic-property-name}/ : get: tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.PowerPropertiesPac" + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" @@ -15377,28 +16068,31 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-rule-group" required: true type: "string" - - name: "connection-end-point-uuid" + - name: "traffic-property-name" in: "path" - description: "Id of connection-end-point" + description: "Id of latency-characteristic" required: true type: "string" responses: 200: - description: "tapi.photonic.media.PowerPropertiesPac" + description: "tapi.topology.LatencyCharacteristic" schema: - $ref: "#/definitions/tapi.photonic.media.PowerPropertiesPac" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/media-channel-connection-end-point-spec/media-channel/measured-power-ingress/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/name={value-name}/: + get: tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.PowerPropertiesPac" + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -15410,28 +16104,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-rule-group" required: true type: "string" - - name: "connection-end-point-uuid" + - name: "value-name" in: "path" - description: "Id of connection-end-point" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.photonic.media.PowerPropertiesPac" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.photonic.media.PowerPropertiesPac" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/media-channel-connection-end-point-spec/media-channel/occupied-spectrum/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/node-edge-point={topology-uuid},{node-edge-point-node-uuid},{node-edge-point-uuid}/ : get: tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.SpectrumBand" + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -15443,28 +16138,40 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "topology-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-edge-point" required: true type: "string" - - name: "connection-end-point-uuid" + - name: "node-edge-point-node-uuid" in: "path" - description: "Id of connection-end-point" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" required: true type: "string" responses: 200: - description: "tapi.photonic.media.SpectrumBand" + description: "tapi.topology.NodeEdgePointRef" schema: - $ref: "#/definitions/tapi.photonic.media.SpectrumBand" + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/media-channel-connection-end-point-spec/media-channel/occupied-spectrum/frequency-constraint/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ : get: tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.FrequencyConstraint" + - "tapi-topology" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." parameters: - name: "uuid" in: "path" @@ -15476,28 +16183,29 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-rule-group" required: true type: "string" - - name: "connection-end-point-uuid" + - name: "risk-characteristic-name" in: "path" - description: "Id of connection-end-point" + description: "Id of risk-characteristic" required: true type: "string" responses: 200: - description: "tapi.photonic.media.FrequencyConstraint" + description: "tapi.topology.RiskCharacteristic" schema: - $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" + $ref: "#/definitions/tapi.topology.RiskCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/: + get: tags: - - "tapi-oam" - description: "returns tapi.oam.MepMipList" + - "tapi-topology" + summary: "returns tapi.topology.Rule" + description: "none" parameters: - name: "uuid" in: "path" @@ -15509,28 +16217,31 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of owned-node-edge-point" + description: "Id of node-rule-group" required: true type: "string" - - name: "connection-end-point-uuid" + - name: "local-id" in: "path" - description: "Id of connection-end-point" + description: "Id of rule" required: true type: "string" responses: 200: - description: "tapi.oam.MepMipList" + description: "tapi.topology.Rule" schema: - $ref: "#/definitions/tapi.oam.MepMipList" + $ref: "#/definitions/tapi.topology.Rule" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/mep={meg-uuid},{mep-local-id}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/name={value-name}/ : get: tags: - - "tapi-oam" - description: "returns tapi.oam.MepRef" + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -15542,38 +16253,35 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of connection-end-point" + description: "Id of node-rule-group" required: true type: "string" - - name: "meg-uuid" + - name: "local-id" in: "path" - description: "Id of mep" + description: "Id of rule" required: true type: "string" - - name: "mep-local-id" + - name: "value-name" in: "path" - description: "Id of mep" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.oam.MepRef" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.oam.MepRef" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/mip={meg-uuid},{mip-local-id}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/ : get: tags: - - "tapi-oam" - description: "returns tapi.oam.MipRef" + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" @@ -15585,38 +16293,25 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" + - name: "node-rule-group-uuid" in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "meg-uuid" - in: "path" - description: "Id of mip" - required: true - type: "string" - - name: "mip-local-id" - in: "path" - description: "Id of mip" + description: "Id of node-rule-group" required: true type: "string" responses: 200: - description: "tapi.oam.MipRef" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.oam.MipRef" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/name={value-name}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/total-size/ : get: tags: - - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -15628,33 +16323,25 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "value-name" + - name: "node-rule-group-uuid" in: "path" - description: "Id of name" + description: "Id of node-rule-group" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/odu-connection-end-point-spec/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/: + get: tags: - - "tapi-odu" - description: "returns tapi.odu.OduConnectionEndPointSpec" + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" @@ -15666,28 +16353,20 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" responses: 200: - description: "tapi.odu.OduConnectionEndPointSpec" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.odu.OduConnectionEndPointSpec" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/odu-connection-end-point-spec/odu-common/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/total-size/: + get: tags: - - "tapi-odu" - description: "returns tapi.odu.OduCommonPac" + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -15699,1691 +16378,147 @@ paths: description: "Id of node" required: true type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" responses: 200: - description: "tapi.odu.OduCommonPac" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.odu.OduCommonPac" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/odu-connection-end-point-spec/odu-ctp/ - : get: + /operations/compute-p-2-p-path/: + post: tags: - - "tapi-odu" - description: "returns tapi.odu.OduCtpPac" + - "tapi-path-computation" + summary: "operates on tapi.path.computation.ComputeP2PPath" + description: "operates on tapi.path.computation.ComputeP2PPath" parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" + - in: "body" + name: "tapi.path.computation.computep2ppath.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.path.computation.computep2ppath.Input" responses: 200: - description: "tapi.odu.OduCtpPac" + description: "Correct response" schema: - $ref: "#/definitions/tapi.odu.OduCtpPac" + $ref: "#/definitions/tapi.path.computation.ComputeP2PPath" + 201: + description: "No response" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/odu-connection-end-point-spec/odu-protection/ - : get: + /operations/create-connectivity-service/: + post: tags: - - "tapi-odu" - description: "returns tapi.odu.OduProtectionPac" + - "tapi-connectivity" + summary: "operates on tapi.connectivity.CreateConnectivityService" + description: "operates on tapi.connectivity.CreateConnectivityService" parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" + - in: "body" + name: "tapi.connectivity.createconnectivityservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.connectivity.createconnectivityservice.Input" responses: 200: - description: "tapi.odu.OduProtectionPac" + description: "Correct response" schema: - $ref: "#/definitions/tapi.odu.OduProtectionPac" + $ref: "#/definitions/tapi.connectivity.CreateConnectivityService" + 201: + description: "No response" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/odu-connection-end-point-spec/odu-term-and-adapter/ - : get: + /operations/create-notification-subscription-service/: + post: tags: - - "tapi-odu" - description: "returns tapi.odu.OduTerminationAndClientAdaptationPac" + - "tapi-notification" + summary: "operates on tapi.notification.CreateNotificationSubscriptionService" + description: "operates on tapi.notification.CreateNotificationSubscriptionService" parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" + - in: "body" + name: "tapi.notification.createnotificationsubscriptionservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.createnotificationsubscriptionservice.Input" responses: 200: - description: "tapi.odu.OduTerminationAndClientAdaptationPac" + description: "Correct response" schema: - $ref: "#/definitions/tapi.odu.OduTerminationAndClientAdaptationPac" + $ref: "#/definitions/tapi.notification.CreateNotificationSubscriptionService" + 201: + description: "No response" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/odu-connection-end-point-spec/odu-term-and-adapter/accepted-payload-type/ - : get: + /operations/create-oam-job/: + post: tags: - - "tapi-odu" - description: "returns tapi.odu.OduPayloadType" + - "tapi-oam" + summary: "operates on tapi.oam.CreateOamJob" + description: "operates on tapi.oam.CreateOamJob" parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" + - in: "body" + name: "tapi.oam.createoamjob.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.createoamjob.Input" responses: 200: - description: "tapi.odu.OduPayloadType" + description: "Correct response" schema: - $ref: "#/definitions/tapi.odu.OduPayloadType" + $ref: "#/definitions/tapi.oam.CreateOamJob" + 201: + description: "No response" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/ots-connection-end-point-spec/ - : get: + /operations/create-oam-profile/: + post: tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.OtsConnectionEndPointSpec" + - "tapi-oam" + summary: "operates on tapi.oam.CreateOamProfile" + description: "operates on tapi.oam.CreateOamProfile" parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" + - in: "body" + name: "tapi.oam.createoamprofile.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.createoamprofile.Input" responses: 200: - description: "tapi.photonic.media.OtsConnectionEndPointSpec" + description: "Correct response" schema: - $ref: "#/definitions/tapi.photonic.media.OtsConnectionEndPointSpec" + $ref: "#/definitions/tapi.oam.CreateOamProfile" + 201: + description: "No response" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/ots-connection-end-point-spec/ots-media-channel/ - : get: + /operations/create-oam-service-point/: + post: tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.MediaChannelPropertiesPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.MediaChannelPropertiesPac" - schema: - $ref: "#/definitions/tapi.photonic.media.MediaChannelPropertiesPac" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/ots-connection-end-point-spec/ots-media-channel/measured-power-egress/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.PowerPropertiesPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.PowerPropertiesPac" - schema: - $ref: "#/definitions/tapi.photonic.media.PowerPropertiesPac" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/ots-connection-end-point-spec/ots-media-channel/measured-power-ingress/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.PowerPropertiesPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.PowerPropertiesPac" - schema: - $ref: "#/definitions/tapi.photonic.media.PowerPropertiesPac" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/ots-connection-end-point-spec/ots-media-channel/occupied-spectrum/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.SpectrumBand" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.SpectrumBand" - schema: - $ref: "#/definitions/tapi.photonic.media.SpectrumBand" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/ots-connection-end-point-spec/ots-media-channel/occupied-spectrum/frequency-constraint/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.FrequencyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.FrequencyConstraint" - schema: - $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/otsi-assembly-connection-end-point-spec/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.OtsiAssemblyConnectionEndPointSpec" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.OtsiAssemblyConnectionEndPointSpec" - schema: - $ref: "#/definitions/tapi.photonic.media.OtsiAssemblyConnectionEndPointSpec" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/otsi-assembly-connection-end-point-spec/fec-parameters/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.FecPropertiesPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.FecPropertiesPac" - schema: - $ref: "#/definitions/tapi.photonic.media.FecPropertiesPac" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/otsi-assembly-connection-end-point-spec/otsi-adapter/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.OtsiGserverAdaptationPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.OtsiGserverAdaptationPac" - schema: - $ref: "#/definitions/tapi.photonic.media.OtsiGserverAdaptationPac" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/otsi-connection-end-point-spec/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.OtsiConnectionEndPointSpec" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.OtsiConnectionEndPointSpec" - schema: - $ref: "#/definitions/tapi.photonic.media.OtsiConnectionEndPointSpec" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/otsi-connection-end-point-spec/otsi-termination/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.OtsiTerminationPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.OtsiTerminationPac" - schema: - $ref: "#/definitions/tapi.photonic.media.OtsiTerminationPac" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/otsi-connection-end-point-spec/otsi-termination/laser-properties/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.LaserPropertiesPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.LaserPropertiesPac" - schema: - $ref: "#/definitions/tapi.photonic.media.LaserPropertiesPac" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/otsi-connection-end-point-spec/otsi-termination/received-power/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.PowerPropertiesPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.PowerPropertiesPac" - schema: - $ref: "#/definitions/tapi.photonic.media.PowerPropertiesPac" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/otsi-connection-end-point-spec/otsi-termination/selected-application-identifier/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.ApplicationIdentifier" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.ApplicationIdentifier" - schema: - $ref: "#/definitions/tapi.photonic.media.ApplicationIdentifier" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/otsi-connection-end-point-spec/otsi-termination/selected-central-frequency/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.CentralFrequency" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.CentralFrequency" - schema: - $ref: "#/definitions/tapi.photonic.media.CentralFrequency" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/otsi-connection-end-point-spec/otsi-termination/selected-central-frequency/frequency-constraint/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.FrequencyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.FrequencyConstraint" - schema: - $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/otsi-connection-end-point-spec/otsi-termination/selected-spectrum/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.SpectrumBand" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.SpectrumBand" - schema: - $ref: "#/definitions/tapi.photonic.media.SpectrumBand" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/otsi-connection-end-point-spec/otsi-termination/selected-spectrum/frequency-constraint/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.FrequencyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.FrequencyConstraint" - schema: - $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/otsi-connection-end-point-spec/otsi-termination/transmited-power/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.PowerPropertiesPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.PowerPropertiesPac" - schema: - $ref: "#/definitions/tapi.photonic.media.PowerPropertiesPac" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/parent-node-edge-point/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/mapped-service-interface-point={service-interface-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.ServiceInterfacePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "service-interface-point-uuid" - in: "path" - description: "Id of mapped-service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.ServiceInterfacePointRef" - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/media-channel-node-edge-point-spec/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.MediaChannelNodeEdgePointSpec" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.MediaChannelNodeEdgePointSpec" - schema: - $ref: "#/definitions/tapi.photonic.media.MediaChannelNodeEdgePointSpec" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/media-channel-node-edge-point-spec/mc-pool/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.MediaChannelPoolCapabilityPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.MediaChannelPoolCapabilityPac" - schema: - $ref: "#/definitions/tapi.photonic.media.MediaChannelPoolCapabilityPac" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/media-channel-node-edge-point-spec/mc-pool/available-spectrum={upper-frequency},{lower-frequency}/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.SpectrumBand" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "upper-frequency" - in: "path" - description: "Id of available-spectrum" - required: true - type: "integer" - format: "int32" - - name: "lower-frequency" - in: "path" - description: "Id of available-spectrum" - required: true - type: "integer" - format: "int32" - responses: - 200: - description: "tapi.photonic.media.SpectrumBand" - schema: - $ref: "#/definitions/tapi.photonic.media.SpectrumBand" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/media-channel-node-edge-point-spec/mc-pool/available-spectrum={upper-frequency},{lower-frequency}/frequency-constraint/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.FrequencyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "upper-frequency" - in: "path" - description: "Id of available-spectrum" - required: true - type: "integer" - format: "int32" - - name: "lower-frequency" - in: "path" - description: "Id of available-spectrum" - required: true - type: "integer" - format: "int32" - responses: - 200: - description: "tapi.photonic.media.FrequencyConstraint" - schema: - $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/media-channel-node-edge-point-spec/mc-pool/occupied-spectrum={upper-frequency},{lower-frequency}/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.SpectrumBand" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "upper-frequency" - in: "path" - description: "Id of occupied-spectrum" - required: true - type: "integer" - format: "int32" - - name: "lower-frequency" - in: "path" - description: "Id of occupied-spectrum" - required: true - type: "integer" - format: "int32" - responses: - 200: - description: "tapi.photonic.media.SpectrumBand" - schema: - $ref: "#/definitions/tapi.photonic.media.SpectrumBand" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/media-channel-node-edge-point-spec/mc-pool/occupied-spectrum={upper-frequency},{lower-frequency}/frequency-constraint/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.FrequencyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "upper-frequency" - in: "path" - description: "Id of occupied-spectrum" - required: true - type: "integer" - format: "int32" - - name: "lower-frequency" - in: "path" - description: "Id of occupied-spectrum" - required: true - type: "integer" - format: "int32" - responses: - 200: - description: "tapi.photonic.media.FrequencyConstraint" - schema: - $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/media-channel-node-edge-point-spec/mc-pool/supportable-spectrum={upper-frequency},{lower-frequency}/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.SpectrumBand" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "upper-frequency" - in: "path" - description: "Id of supportable-spectrum" - required: true - type: "integer" - format: "int32" - - name: "lower-frequency" - in: "path" - description: "Id of supportable-spectrum" - required: true - type: "integer" - format: "int32" - responses: - 200: - description: "tapi.photonic.media.SpectrumBand" - schema: - $ref: "#/definitions/tapi.photonic.media.SpectrumBand" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/media-channel-node-edge-point-spec/mc-pool/supportable-spectrum={upper-frequency},{lower-frequency}/frequency-constraint/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.FrequencyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "upper-frequency" - in: "path" - description: "Id of supportable-spectrum" - required: true - type: "integer" - format: "int32" - - name: "lower-frequency" - in: "path" - description: "Id of supportable-spectrum" - required: true - type: "integer" - format: "int32" - responses: - 200: - description: "tapi.photonic.media.FrequencyConstraint" - schema: - $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/name={value-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/odu-node-edge-point-spec/ - : get: - tags: - - "tapi-odu" - description: "returns tapi.odu.OduNodeEdgePointSpec" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.odu.OduNodeEdgePointSpec" - schema: - $ref: "#/definitions/tapi.odu.OduNodeEdgePointSpec" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/odu-node-edge-point-spec/odu-pool/ - : get: - tags: - - "tapi-odu" - description: "returns tapi.odu.OduPoolPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.odu.OduPoolPac" - schema: - $ref: "#/definitions/tapi.odu.OduPoolPac" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /operations/compute-p-2-p-path/: - post: - tags: - - "tapi-path-computation" - parameters: - - in: "body" - name: "tapi.path.computation.computep2ppath.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.path.computation.computep2ppath.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.path.computation.ComputeP2PPath" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/create-connectivity-service/: - post: - tags: - - "tapi-connectivity" - parameters: - - in: "body" - name: "tapi.connectivity.createconnectivityservice.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.connectivity.createconnectivityservice.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.connectivity.CreateConnectivityService" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/create-notification-subscription-service/: - post: - tags: - - "tapi-notification" - parameters: - - in: "body" - name: "tapi.notification.createnotificationsubscriptionservice.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.notification.createnotificationsubscriptionservice.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.CreateNotificationSubscriptionService" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/create-oam-job/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.createoamjob.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.createoamjob.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.CreateOamJob" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/create-oam-service-end-point/: - post: - tags: - - "tapi-oam" + - "tapi-oam" + summary: "operates on tapi.oam.CreateOamServicePoint" + description: "operates on tapi.oam.CreateOamServicePoint" parameters: - in: "body" - name: "tapi.oam.createoamserviceendpoint.Input.body-param" + name: "tapi.oam.createoamservicepoint.Input.body-param" required: false schema: properties: input: - $ref: "#/definitions/tapi.oam.createoamserviceendpoint.Input" + $ref: "#/definitions/tapi.oam.createoamservicepoint.Input" responses: 200: description: "Correct response" schema: - $ref: "#/definitions/tapi.oam.CreateOamServiceEndPoint" + $ref: "#/definitions/tapi.oam.CreateOamServicePoint" 201: description: "No response" 400: @@ -17392,6 +16527,8 @@ paths: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.CreateOamService" + description: "operates on tapi.oam.CreateOamService" parameters: - in: "body" name: "tapi.oam.createoamservice.Input.body-param" @@ -17413,6 +16550,8 @@ paths: post: tags: - "tapi-connectivity" + summary: "operates on tapi.connectivity.DeleteConnectivityService" + description: "operates on tapi.connectivity.DeleteConnectivityService" parameters: - in: "body" name: "tapi.connectivity.deleteconnectivityservice.Input.body-param" @@ -17430,6 +16569,8 @@ paths: post: tags: - "tapi-notification" + summary: "operates on tapi.notification.DeleteNotificationSubscriptionService" + description: "operates on tapi.notification.DeleteNotificationSubscriptionService" parameters: - in: "body" name: "tapi.notification.deletenotificationsubscriptionservice.Input.body-param" @@ -17439,10 +16580,6 @@ paths: input: $ref: "#/definitions/tapi.notification.deletenotificationsubscriptionservice.Input" responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.DeleteNotificationSubscriptionService" 201: description: "No response" 400: @@ -17451,6 +16588,8 @@ paths: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.DeleteOamJob" + description: "operates on tapi.oam.DeleteOamJob" parameters: - in: "body" name: "tapi.oam.deleteoamjob.Input.body-param" @@ -17464,18 +16603,39 @@ paths: description: "No response" 400: description: "Internal error" - /operations/delete-oam-service-end-point/: + /operations/delete-oam-profile/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.DeleteOamProfile" + description: "operates on tapi.oam.DeleteOamProfile" + parameters: + - in: "body" + name: "tapi.oam.deleteoamprofile.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.deleteoamprofile.Input" + responses: + 201: + description: "No response" + 400: + description: "Internal error" + /operations/delete-oam-service-point/: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.DeleteOamServicePoint" + description: "operates on tapi.oam.DeleteOamServicePoint" parameters: - in: "body" - name: "tapi.oam.deleteoamserviceendpoint.Input.body-param" + name: "tapi.oam.deleteoamservicepoint.Input.body-param" required: false schema: properties: input: - $ref: "#/definitions/tapi.oam.deleteoamserviceendpoint.Input" + $ref: "#/definitions/tapi.oam.deleteoamservicepoint.Input" responses: 201: description: "No response" @@ -17485,6 +16645,8 @@ paths: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.DeleteOamService" + description: "operates on tapi.oam.DeleteOamService" parameters: - in: "body" name: "tapi.oam.deleteoamservice.Input.body-param" @@ -17502,6 +16664,8 @@ paths: post: tags: - "tapi-path-computation" + summary: "operates on tapi.path.computation.DeleteP2PPath" + description: "operates on tapi.path.computation.DeleteP2PPath" parameters: - in: "body" name: "tapi.path.computation.deletep2ppath.Input.body-param" @@ -17523,6 +16687,8 @@ paths: post: tags: - "tapi-connectivity" + summary: "operates on tapi.connectivity.GetConnectionDetails" + description: "operates on tapi.connectivity.GetConnectionDetails" parameters: - in: "body" name: "tapi.connectivity.getconnectiondetails.Input.body-param" @@ -17544,6 +16710,8 @@ paths: post: tags: - "tapi-connectivity" + summary: "operates on tapi.connectivity.GetConnectionEndPointDetails" + description: "operates on tapi.connectivity.GetConnectionEndPointDetails" parameters: - in: "body" name: "tapi.connectivity.getconnectionendpointdetails.Input.body-param" @@ -17565,6 +16733,8 @@ paths: post: tags: - "tapi-connectivity" + summary: "operates on tapi.connectivity.GetConnectivityServiceDetails" + description: "operates on tapi.connectivity.GetConnectivityServiceDetails" parameters: - in: "body" name: "tapi.connectivity.getconnectivityservicedetails.Input.body-param" @@ -17600,6 +16770,8 @@ paths: post: tags: - "tapi-topology" + summary: "operates on tapi.topology.GetLinkDetails" + description: "operates on tapi.topology.GetLinkDetails" parameters: - in: "body" name: "tapi.topology.getlinkdetails.Input.body-param" @@ -17621,6 +16793,8 @@ paths: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.GetMeg" + description: "operates on tapi.oam.GetMeg" parameters: - in: "body" name: "tapi.oam.getmeg.Input.body-param" @@ -17642,6 +16816,8 @@ paths: post: tags: - "tapi-topology" + summary: "operates on tapi.topology.GetNodeDetails" + description: "operates on tapi.topology.GetNodeDetails" parameters: - in: "body" name: "tapi.topology.getnodedetails.Input.body-param" @@ -17663,6 +16839,8 @@ paths: post: tags: - "tapi-topology" + summary: "operates on tapi.topology.GetNodeEdgePointDetails" + description: "operates on tapi.topology.GetNodeEdgePointDetails" parameters: - in: "body" name: "tapi.topology.getnodeedgepointdetails.Input.body-param" @@ -17684,6 +16862,8 @@ paths: post: tags: - "tapi-notification" + summary: "operates on tapi.notification.GetNotificationList" + description: "operates on tapi.notification.GetNotificationList" parameters: - in: "body" name: "tapi.notification.getnotificationlist.Input.body-param" @@ -17705,6 +16885,8 @@ paths: post: tags: - "tapi-notification" + summary: "operates on tapi.notification.GetNotificationSubscriptionServiceDetails" + description: "operates on tapi.notification.GetNotificationSubscriptionServiceDetails" parameters: - in: "body" name: "tapi.notification.getnotificationsubscriptionservicedetails.Input.body-param" @@ -17736,10 +16918,26 @@ paths: description: "No response" 400: description: "Internal error" + /operations/get-oam-job-list/: + post: + tags: + - "tapi-oam" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetOamJobList" + 201: + description: "No response" + 400: + description: "Internal error" /operations/get-oam-job/: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.GetOamJob" + description: "operates on tapi.oam.GetOamJob" parameters: - in: "body" name: "tapi.oam.getoamjob.Input.body-param" @@ -17757,23 +16955,39 @@ paths: description: "No response" 400: description: "Internal error" - /operations/get-oam-service-end-point/: + /operations/get-oam-profile-list/: + post: + tags: + - "tapi-oam" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetOamProfileList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-oam-profile/: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.GetOamProfile" + description: "operates on tapi.oam.GetOamProfile" parameters: - in: "body" - name: "tapi.oam.getoamserviceendpoint.Input.body-param" + name: "tapi.oam.getoamprofile.Input.body-param" required: false schema: properties: input: - $ref: "#/definitions/tapi.oam.getoamserviceendpoint.Input" + $ref: "#/definitions/tapi.oam.getoamprofile.Input" responses: 200: description: "Correct response" schema: - $ref: "#/definitions/tapi.oam.GetOamServiceEndPoint" + $ref: "#/definitions/tapi.oam.GetOamProfile" 201: description: "No response" 400: @@ -17792,10 +17006,35 @@ paths: description: "No response" 400: description: "Internal error" + /operations/get-oam-service-point/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.GetOamServicePoint" + description: "operates on tapi.oam.GetOamServicePoint" + parameters: + - in: "body" + name: "tapi.oam.getoamservicepoint.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.getoamservicepoint.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetOamServicePoint" + 201: + description: "No response" + 400: + description: "Internal error" /operations/get-oam-service/: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.GetOamService" + description: "operates on tapi.oam.GetOamService" parameters: - in: "body" name: "tapi.oam.getoamservice.Input.body-param" @@ -17817,6 +17056,8 @@ paths: post: tags: - "tapi-common" + summary: "operates on tapi.common.GetServiceInterfacePointDetails" + description: "operates on tapi.common.GetServiceInterfacePointDetails" parameters: - in: "body" name: "tapi.common.getserviceinterfacepointdetails.Input.body-param" @@ -17866,6 +17107,8 @@ paths: post: tags: - "tapi-topology" + summary: "operates on tapi.topology.GetTopologyDetails" + description: "operates on tapi.topology.GetTopologyDetails" parameters: - in: "body" name: "tapi.topology.gettopologydetails.Input.body-param" @@ -17901,6 +17144,8 @@ paths: post: tags: - "tapi-path-computation" + summary: "operates on tapi.path.computation.OptimizeP2PPath" + description: "operates on tapi.path.computation.OptimizeP2PPath" parameters: - in: "body" name: "tapi.path.computation.optimizep2ppath.Input.body-param" @@ -17922,6 +17167,8 @@ paths: post: tags: - "tapi-connectivity" + summary: "operates on tapi.connectivity.UpdateConnectivityService" + description: "operates on tapi.connectivity.UpdateConnectivityService" parameters: - in: "body" name: "tapi.connectivity.updateconnectivityservice.Input.body-param" @@ -17943,6 +17190,8 @@ paths: post: tags: - "tapi-notification" + summary: "operates on tapi.notification.UpdateNotificationSubscriptionService" + description: "operates on tapi.notification.UpdateNotificationSubscriptionService" parameters: - in: "body" name: "tapi.notification.updatenotificationsubscriptionservice.Input.body-param" @@ -17964,6 +17213,8 @@ paths: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.UpdateOamJob" + description: "operates on tapi.oam.UpdateOamJob" parameters: - in: "body" name: "tapi.oam.updateoamjob.Input.body-param" @@ -17981,23 +17232,48 @@ paths: description: "No response" 400: description: "Internal error" - /operations/update-oam-service-end-point/: + /operations/update-oam-profile/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.UpdateOamProfile" + description: "operates on tapi.oam.UpdateOamProfile" + parameters: + - in: "body" + name: "tapi.oam.updateoamprofile.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.updateoamprofile.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.UpdateOamProfile" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/update-oam-service-point/: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.UpdateOamServicePoint" + description: "operates on tapi.oam.UpdateOamServicePoint" parameters: - in: "body" - name: "tapi.oam.updateoamserviceendpoint.Input.body-param" + name: "tapi.oam.updateoamservicepoint.Input.body-param" required: false schema: properties: input: - $ref: "#/definitions/tapi.oam.updateoamserviceendpoint.Input" + $ref: "#/definitions/tapi.oam.updateoamservicepoint.Input" responses: 200: description: "Correct response" schema: - $ref: "#/definitions/tapi.oam.UpdateOamServiceEndPoint" + $ref: "#/definitions/tapi.oam.UpdateOamServicePoint" 201: description: "No response" 400: @@ -18006,6 +17282,8 @@ paths: post: tags: - "tapi-oam" + summary: "operates on tapi.oam.UpdateOamService" + description: "operates on tapi.oam.UpdateOamService" parameters: - in: "body" name: "tapi.oam.updateoamservice.Input.body-param" @@ -18027,6 +17305,8 @@ paths: post: tags: - "tapi-common" + summary: "operates on tapi.common.UpdateServiceInterfacePoint" + description: "operates on tapi.common.UpdateServiceInterfacePoint" parameters: - in: "body" name: "tapi.common.updateserviceinterfacepoint.Input.body-param" @@ -18058,45 +17338,9 @@ definitions: enum: - "LOCKED" - "UNLOCKED" - tapi.common.BandwidthProfile: - type: "object" - properties: - committed-information-rate: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - coupling-flag: - type: "boolean" - description: "none" - default: false - bw-profile-type: - description: "none" - $ref: "#/definitions/tapi.common.BandwidthProfileType" - peak-information-rate: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - committed-burst-size: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - peak-burst-size: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - color-aware: - type: "boolean" - description: "none" - default: false - tapi.common.BandwidthProfileType: - type: "string" - enum: - - "MEF_10.x" - - "RFC_2697" - - "RFC_2698" - - "RFC_4115" tapi.common.Capacity: type: "object" properties: - bandwidth-profile: - description: "none" - $ref: "#/definitions/tapi.common.BandwidthProfile" total-size: description: "Total capacity of the TopologicalEntity in MB/s. In case of\ \ bandwidthProfile, this is expected to same as the committedInformationRate." @@ -18138,9 +17382,9 @@ definitions: allOf: - $ref: "#/definitions/tapi.common.GlobalClass" - $ref: "#/definitions/tapi.connectivity.ContextAugmentation4" - - $ref: "#/definitions/tapi.notification.ContextAugmentation2" - - $ref: "#/definitions/tapi.oam.ContextAugmentation1" - - $ref: "#/definitions/tapi.path.computation.ContextAugmentation3" + - $ref: "#/definitions/tapi.notification.ContextAugmentation1" + - $ref: "#/definitions/tapi.oam.ContextAugmentation3" + - $ref: "#/definitions/tapi.path.computation.ContextAugmentation2" - $ref: "#/definitions/tapi.topology.ContextAugmentation5" - type: "object" properties: @@ -18179,21 +17423,21 @@ definitions: properties: name: type: "array" - description: "List of names. A property of an entity with a value that is\ - \ unique in some namespace but may change during the life of the entity.\ - \ A name carries no semantics with respect to the purpose of the entity." + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." items: $ref: "#/definitions/tapi.common.NameAndValue" uuid: type: "string" description: "UUID: An identifier that is universally unique within an identifier\ - \ space, where the identifier space is itself globally unique, and immutable.\ - \ An UUID carries no semantics with respect to the purpose or state of the\ - \ entity.\r\n UUID here uses string representation as\ - \ defined in RFC 4122. The canonical representation uses lowercase characters.\r\ - \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ - \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ - \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a UUID\ + \ in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.common.LayerProtocolName: type: "string" enum: @@ -18214,9 +17458,9 @@ definitions: properties: name: type: "array" - description: "List of names. A property of an entity with a value that is\ - \ unique in some namespace but may change during the life of the entity.\ - \ A name carries no semantics with respect to the purpose of the entity." + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." items: $ref: "#/definitions/tapi.common.NameAndValue" local-id: @@ -18278,7 +17522,7 @@ definitions: $ref: "#/definitions/tapi.common.LayerProtocolName" description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ \ termination and adaptation functions of one or more transport layers. \r\ - \n The structure of LTP supports all transport protocols including\ + \n The structure of LTP supports all transport protocols including\ \ circuit and packet forms." tapi.common.ServiceInterfacePointRef: type: "object" @@ -18298,11 +17542,11 @@ definitions: type: "object" properties: termination-direction: - description: "The overall directionality of the LP. \r\n \ - \ - A BIDIRECTIONAL LP will have some SINK and/or SOURCE flowss.\r\n \ - \ - A SINK LP can only contain elements with SINK flows\ - \ or CONTRA_DIRECTION_SOURCE flows\r\n - A SOURCE LP\ - \ can only contain SOURCE flows or CONTRA_DIRECTION_SINK flows" + description: "The overall directionality of the LP. \r\n -\ + \ A BIDIRECTIONAL LP will have some SINK and/or SOURCE flowss.\r\n \ + \ - A SINK LP can only contain elements with SINK flows or CONTRA_DIRECTION_SOURCE\ + \ flows\r\n - A SOURCE LP can only contain SOURCE flows or\ + \ CONTRA_DIRECTION_SINK flows" $ref: "#/definitions/tapi.common.TerminationDirection" termination-state: description: "Indicates whether the layer is terminated and if so how." @@ -18365,9 +17609,16 @@ definitions: tapi.common.getserviceinterfacepointdetails.Input: type: "object" properties: - sip-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.common.getserviceinterfacepointdetails.Output: type: "object" properties: @@ -18390,9 +17641,16 @@ definitions: tapi.common.updateserviceinterfacepoint.Input: type: "object" properties: - sip-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" state: description: "none" $ref: "#/definitions/tapi.common.AdministrativeState" @@ -18412,11 +17670,11 @@ definitions: description: "An Connection object supports a recursive aggregation relationship\ \ such that the internal construction of an Connection can be exposed\ \ as multiple lower level Connection objects (partitioning).\r\n \ - \ Aggregation is used as for the Node/Topology to allow\ - \ changes in hierarchy. \r\n Connection aggregation\ - \ reflects Node/Topology aggregation. \r\n The FC represents\ - \ a Cross-Connection in an NE. The Cross-Connection in an NE is not necessarily\ - \ the lowest level of FC partitioning." + \ Aggregation is used as for the Node/Topology to allow changes\ + \ in hierarchy. \r\n Connection aggregation reflects Node/Topology\ + \ aggregation. \r\n The FC represents a Cross-Connection\ + \ in an NE. The Cross-Connection in an NE is not necessarily the lowest\ + \ level of FC partitioning." items: $ref: "#/definitions/tapi.connectivity.ConnectionRef" switch-control: @@ -18429,6 +17687,9 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.connectivity.Route" + bounding-node: + description: "none" + $ref: "#/definitions/tapi.topology.NodeRef" layer-protocol-name: description: "none" $ref: "#/definitions/tapi.common.LayerProtocolName" @@ -18442,9 +17703,8 @@ definitions: $ref: "#/definitions/tapi.common.ForwardingDirection" description: "The ForwardingConstruct (FC) object class models enabled potential\ \ for forwarding between two or more LTPs and like the LTP supports any transport\ - \ protocol including all circuit and packet forms.\r\n At the\ - \ lowest level of recursion, a FC represents a cross-connection within an\ - \ NE." + \ protocol including all circuit and packet forms.\r\n At the lowest\ + \ level of recursion, a FC represents a cross-connection within an NE." tapi.connectivity.ConnectionEndPoint: allOf: - $ref: "#/definitions/tapi.common.GlobalClass" @@ -18452,6 +17712,9 @@ definitions: - $ref: "#/definitions/tapi.common.TerminationPac" - type: "object" properties: + protection-role: + description: "none" + $ref: "#/definitions/tapi.connectivity.ProtectionRole" client-node-edge-point: type: "array" description: "none" @@ -18481,7 +17744,7 @@ definitions: $ref: "#/definitions/tapi.common.PortDirection" description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ \ termination and adaptation functions of one or more transport layers. \r\ - \n The structure of LTP supports all transport protocols including\ + \n The structure of LTP supports all transport protocols including\ \ circuit and packet forms." tapi.connectivity.ConnectionEndPointRef: allOf: @@ -18491,7 +17754,7 @@ definitions: connection-end-point-uuid: type: "string" description: "none" - x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:owned-node-edge-point/tapi-connectivity:cep-list/tapi-connectivity:connection-end-point/tapi-connectivity:uuid" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:node-edge-point/tapi-connectivity:cep-list/tapi-connectivity:connection-end-point/tapi-connectivity:uuid" description: "none" tapi.connectivity.ConnectionRef: type: "object" @@ -18503,15 +17766,9 @@ definitions: tapi.connectivity.ConnectivityConstraint: type: "object" properties: - service-layer: - description: "none" - $ref: "#/definitions/tapi.common.LayerProtocolName" schedule: description: "none" $ref: "#/definitions/tapi.common.TimeRange" - connectivity-direction: - description: "none" - $ref: "#/definitions/tapi.common.ForwardingDirection" requested-capacity: description: "none" $ref: "#/definitions/tapi.common.Capacity" @@ -18524,7 +17781,7 @@ definitions: type: "string" description: "An abstract value the meaning of which is mutually agreed \ \ typically represents metrics such as - Class of service, priority, resiliency,\ - \ availability" + \ availability\r\n Class of Service Name." service-type: description: "none" $ref: "#/definitions/tapi.connectivity.ServiceType" @@ -18544,27 +17801,6 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.connectivity.Connection" - tapi.connectivity.ConnectivityService: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" - - $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" - - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - - type: "object" - properties: - end-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" - connection: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.connectivity.ConnectionRef" - description: "none" tapi.connectivity.ConnectivityServiceEndPoint: allOf: - $ref: "#/definitions/tapi.common.AdminStatePac" @@ -18583,6 +17819,9 @@ definitions: service-interface-point: description: "none" $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + peer-fwd-connectivity-service-end-point: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" layer-protocol-name: description: "none" $ref: "#/definitions/tapi.common.LayerProtocolName" @@ -18594,23 +17833,29 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.connectivity.ConnectionEndPointRef" + server-connectivity-service-end-point: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" direction: description: "The orientation of defined flow at the EndPoint." $ref: "#/definitions/tapi.common.PortDirection" capacity: description: "none" $ref: "#/definitions/tapi.common.Capacity" + protecting-connectivity-service-end-point: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" description: "The association of the FC to LTPs is made via EndPoints.\r\n \ - \ The EndPoint (EP) object class models the access to the FC\ - \ function. \r\n The traffic forwarding between the associated\ - \ EPs of the FC depends upon the type of FC and may be associated with FcSwitch\ - \ object instances. \r\n In cases where there is resilience\ - \ the EndPoint may convey the resilience role of the access to the FC. \r\n\ - \ It can represent a protected (resilient/reliable) point or\ - \ a protecting (unreliable working or protection) point.\r\n \ - \ The EP replaces the Protection Unit of a traditional protection model.\ - \ \r\n The ForwadingConstruct can be considered as a component\ - \ and the EndPoint as a Port on that component" + \ The EndPoint (EP) object class models the access to the FC function.\ + \ \r\n The traffic forwarding between the associated EPs of the\ + \ FC depends upon the type of FC and may be associated with FcSwitch object\ + \ instances. \r\n In cases where there is resilience the EndPoint\ + \ may convey the resilience role of the access to the FC. \r\n \ + \ It can represent a protected (resilient/reliable) point or a protecting\ + \ (unreliable working or protection) point.\r\n The EP replaces\ + \ the Protection Unit of a traditional protection model. \r\n The\ + \ ForwadingConstruct can be considered as a component and the EndPoint as\ + \ a Port on that component" tapi.connectivity.ConnectivityServiceEndPointRef: allOf: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" @@ -18668,12 +17913,12 @@ definitions: properties: output: $ref: "#/definitions/tapi.connectivity.getconnectivityservicelist.Output" - tapi.connectivity.OwnedNodeEdgePointAugmentation3: + tapi.connectivity.NodeEdgePointAugmentation1: type: "object" properties: cep-list: description: "none" - $ref: "#/definitions/tapi.connectivity.context.topologycontext.topology.node.ownednodeedgepoint.CepList" + $ref: "#/definitions/tapi.connectivity.context.topologycontext.topology.node.nodeedgepoint.CepList" x-augmentation: prefix: "tapi-connectivity" namespace: "urn:onf:otcc:yang:tapi-connectivity" @@ -18692,40 +17937,26 @@ definitions: is-lock-out: type: "boolean" description: "The resource is configured to temporarily not be available for\ - \ use in the protection scheme(s) it is part of.\r\n \ - \ This overrides all other protection control states including forced.\r\ - \n If the item is locked out then it cannot be used under\ - \ any circumstances.\r\n Note: Only relevant when part\ - \ of a protection scheme." + \ use in the protection scheme(s) it is part of.\r\n This\ + \ overrides all other protection control states including forced.\r\n \ + \ If the item is locked out then it cannot be used under any\ + \ circumstances.\r\n Note: Only relevant when part of a protection\ + \ scheme." default: false max-switch-times: type: "integer" format: "int32" description: "Used to limit the maximum swtich times. When work fault disappears\ \ , and traffic return to the original work path, switch counter reset." - restoration-coordinate-type: - description: " The coordination mechanism between multi-layers." - $ref: "#/definitions/tapi.connectivity.CoordinateType" - is-coordinated-switching-both-ends: - type: "boolean" - description: "Is operating such that switching at both ends of each flow acorss\ - \ the FC is coordinated at both ingress and egress ends." - default: false + protection-type: + description: "none" + $ref: "#/definitions/tapi.topology.ProtectionType" hold-off-time: type: "integer" format: "int32" description: "This attribute indicates the time, in milliseconds, between\ \ declaration of signal degrade or signal fail, and the initialization of\ \ the protection switching algorithm." - is-frozen: - type: "boolean" - description: "Temporarily prevents any switch action to be taken and, as such,\ - \ freezes the current state. \r\n Until the freeze is\ - \ cleared, additional near-end external commands are rejected and fault\ - \ condition changes and received APS messages are ignored.\r\n \ - \ All administrative controls of any aspect of protection are\ - \ rejected." - default: false wait-to-revert-time: type: "integer" format: "int32" @@ -18733,9 +17964,9 @@ definitions: \ the time, in minutes, to wait after a fault clears on a higher priority\ \ (preferred) resource before reverting to the preferred resource." default: 15 - resilience-type: - description: "none" - $ref: "#/definitions/tapi.topology.ResilienceType" + selection-control: + description: "Degree of administrative control applied to the switch selection." + $ref: "#/definitions/tapi.connectivity.SelectionControl" preferred-restoration-layer: type: "array" description: "Indicate which layer this resilience parameters package configured\ @@ -18746,6 +17977,28 @@ definitions: type: "integer" format: "int32" description: "none" + restoration-policy: + description: "none" + $ref: "#/definitions/tapi.topology.RestorationPolicy" + restoration-coordinate-type: + description: " The coordination mechanism between multi-layers." + $ref: "#/definitions/tapi.connectivity.CoordinateType" + is-coordinated-switching-both-ends: + type: "boolean" + description: "Is operating such that switching at both ends of each flow acorss\ + \ the FC is coordinated at both ingress and egress ends." + default: false + fault-condition-determination: + type: "string" + description: "none" + is-frozen: + type: "boolean" + description: "Temporarily prevents any switch action to be taken and, as such,\ + \ freezes the current state. \r\n Until the freeze is cleared,\ + \ additional near-end external commands are rejected and fault condition\ + \ changes and received APS messages are ignored.\r\n All\ + \ administrative controls of any aspect of protection are rejected." + default: false reversion-mode: description: "Indcates whether the protection scheme is revertive or non-revertive." $ref: "#/definitions/tapi.connectivity.ReversionMode" @@ -18765,9 +18018,9 @@ definitions: items: $ref: "#/definitions/tapi.connectivity.ConnectionEndPointRef" description: "The FC Route (FcRoute) object class models the individual routes\ - \ of an FC. \r\n The route of an FC object is represented by\ - \ a list of FCs at a lower level. \r\n Note that depending\ - \ on the service supported by an FC, an the FC can have multiple routes." + \ of an FC. \r\n The route of an FC object is represented by a\ + \ list of FCs at a lower level. \r\n Note that depending on the\ + \ service supported by an FC, an the FC can have multiple routes." tapi.connectivity.RouteRef: allOf: - $ref: "#/definitions/tapi.connectivity.ConnectionRef" @@ -18817,9 +18070,6 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.connectivity.RouteRef" - selection-control: - description: "Degree of administrative control applied to the switch selection." - $ref: "#/definitions/tapi.connectivity.SelectionControl" selection-reason: description: "The reason for the current switch selection." $ref: "#/definitions/tapi.connectivity.SelectionReason" @@ -18829,32 +18079,31 @@ definitions: $ref: "#/definitions/tapi.common.PortDirection" description: "The class models the switched forwarding of traffic (traffic flow)\ \ between FcPorts (ConnectionEndPoints) and is present where there is protection\ - \ functionality in the FC (Connection). \r\n If an FC exposes\ - \ protection (having two or more FcPorts that provide alternative identical\ - \ inputs/outputs), the FC will have one or more associated FcSwitch objects\ - \ to represent the alternative flow choices visible at the edge of the FC.\r\ - \n The FC switch represents and defines a protection switch\ - \ structure encapsulated in the FC. \r\n Essentially performs\ - \ one of the functions of the Protection Group in a traditional model. It\ - \ associates to 2 or more FcPorts each playing the role of a Protection Unit.\ - \ \r\n One or more protection, i.e. standby/backup, FcPorts\ - \ provide protection for one or more working (i.e. regular/main/preferred)\ - \ FcPorts where either protection or working can feed one or more protected\ - \ FcPort.\r\n The switch may be used in revertive or non-revertive\ - \ (symmetric) mode. When in revertive mode it may define a waitToRestore time.\r\ - \n It may be used in one of several modes including source\ - \ switch, destination switched, source and destination switched etc (covering\ - \ cases such as 1+1 and 1:1).\r\n It may be locked out (prevented\ - \ from switching), force switched or manual switched.\r\n It\ - \ will indicate switch state and change of state.\r\n The switch\ - \ can be switched away from all sources such that it becomes open and hence\ - \ two coordinated switches can both feed the same LTP so long as at least\ - \ one of the two is switched away from all sources (is 'open').\r\n \ - \ The ability for a Switch to be 'high impedance' allows bidirectional\ - \ ForwardingConstructs to be overlaid on the same bidirectional LTP where\ - \ the appropriate control is enabled to prevent signal conflict.\r\n \ - \ This ability allows multiple alternate routes to be present that\ - \ otherwise would be in conflict." + \ functionality in the FC (Connection). \r\n If an FC exposes protection\ + \ (having two or more FcPorts that provide alternative identical inputs/outputs),\ + \ the FC will have one or more associated FcSwitch objects to represent the\ + \ alternative flow choices visible at the edge of the FC.\r\n The\ + \ FC switch represents and defines a protection switch structure encapsulated\ + \ in the FC. \r\n Essentially performs one of the functions of\ + \ the Protection Group in a traditional model. It associates to 2 or more\ + \ FcPorts each playing the role of a Protection Unit. \r\n One\ + \ or more protection, i.e. standby/backup, FcPorts provide protection for\ + \ one or more working (i.e. regular/main/preferred) FcPorts where either protection\ + \ or working can feed one or more protected FcPort.\r\n The switch\ + \ may be used in revertive or non-revertive (symmetric) mode. When in revertive\ + \ mode it may define a waitToRestore time.\r\n It may be used in\ + \ one of several modes including source switch, destination switched, source\ + \ and destination switched etc (covering cases such as 1+1 and 1:1).\r\n \ + \ It may be locked out (prevented from switching), force switched\ + \ or manual switched.\r\n It will indicate switch state and change\ + \ of state.\r\n The switch can be switched away from all sources\ + \ such that it becomes open and hence two coordinated switches can both feed\ + \ the same LTP so long as at least one of the two is switched away from all\ + \ sources (is 'open').\r\n The ability for a Switch to be 'high\ + \ impedance' allows bidirectional ForwardingConstructs to be overlaid on the\ + \ same bidirectional LTP where the appropriate control is enabled to prevent\ + \ signal conflict.\r\n This ability allows multiple alternate routes\ + \ to be present that otherwise would be in conflict." tapi.connectivity.SwitchControl: allOf: - $ref: "#/definitions/tapi.common.GlobalClass" @@ -18892,40 +18141,55 @@ definitions: tapi.connectivity.ceplist.ConnectionEndPoint: allOf: - $ref: "#/definitions/tapi.connectivity.ConnectionEndPoint" - - $ref: "#/definitions/tapi.oam.ConnectionEndPointAugmentation2" - - $ref: "#/definitions/tapi.odu.ConnectionEndPointAugmentation1" + - $ref: "#/definitions/tapi.oam.ConnectionEndPointAugmentation4" + - $ref: "#/definitions/tapi.odu.ConnectionEndPointAugmentation5" + - $ref: "#/definitions/tapi.photonic.media.ConnectionEndPointAugmentation1" + - $ref: "#/definitions/tapi.photonic.media.ConnectionEndPointAugmentation2" - $ref: "#/definitions/tapi.photonic.media.ConnectionEndPointAugmentation3" - - $ref: "#/definitions/tapi.photonic.media.ConnectionEndPointAugmentation4" - - $ref: "#/definitions/tapi.photonic.media.ConnectionEndPointAugmentation5" - - $ref: "#/definitions/tapi.photonic.media.ConnectionEndPointAugmentation6" - - $ref: "#/definitions/tapi.photonic.media.ConnectionEndPointAugmentation7" tapi.connectivity.connectivitycontext.ConnectivityService: allOf: - $ref: "#/definitions/tapi.common.AdminStatePac" - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" - - $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" - - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - type: "object" properties: + topology-constraint: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" end-point: type: "array" description: "none" items: $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" + resilience-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" connection: type: "array" description: "none" items: $ref: "#/definitions/tapi.connectivity.ConnectionRef" + connectivity-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + direction: + description: "none" + $ref: "#/definitions/tapi.common.ForwardingDirection" description: "none" tapi.connectivity.connectivityservice.EndPoint: allOf: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" + - $ref: "#/definitions/tapi.odu.EndPointAugmentation3" - $ref: "#/definitions/tapi.photonic.media.EndPointAugmentation1" - $ref: "#/definitions/tapi.photonic.media.EndPointAugmentation2" - tapi.connectivity.context.topologycontext.topology.node.ownednodeedgepoint.CepList: + tapi.connectivity.context.topologycontext.topology.node.nodeedgepoint.CepList: allOf: - type: "object" properties: @@ -18939,64 +18203,121 @@ definitions: type: "object" properties: topology-constraint: + type: "array" description: "none" - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" end-point: type: "array" description: "none" items: - $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" + $ref: "#/definitions/tapi.connectivity.createconnectivityservice.input.EndPoint" resilience-constraint: description: "none" $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" routing-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.RoutingConstraint" state: - type: "string" description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" connectivity-constraint: description: "none" $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.connectivity.createconnectivityservice.Output: type: "object" properties: service: description: "none" $ref: "#/definitions/tapi.connectivity.createconnectivityservice.output.Service" + tapi.connectivity.createconnectivityservice.input.EndPoint: + allOf: + - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" + - $ref: "#/definitions/tapi.photonic.media.EndPointAugmentation1" + - $ref: "#/definitions/tapi.photonic.media.EndPointAugmentation2" tapi.connectivity.createconnectivityservice.output.Service: allOf: - $ref: "#/definitions/tapi.common.AdminStatePac" - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" - - $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" - - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - type: "object" properties: + topology-constraint: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" end-point: type: "array" description: "none" items: - $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" + $ref: "#/definitions/tapi.connectivity.createconnectivityservice.input.EndPoint" + resilience-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" connection: type: "array" description: "none" items: $ref: "#/definitions/tapi.connectivity.ConnectionRef" + connectivity-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + direction: + description: "none" + $ref: "#/definitions/tapi.common.ForwardingDirection" description: "none" tapi.connectivity.deleteconnectivityservice.Input: type: "object" properties: - service-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.connectivity.getconnectiondetails.Input: type: "object" properties: - connection-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.connectivity.getconnectiondetails.Output: type: "object" properties: @@ -19006,18 +18327,16 @@ definitions: tapi.connectivity.getconnectionendpointdetails.Input: type: "object" properties: - cep-id-or-name: - type: "string" - description: "none" - nep-id-or-name: - type: "string" - description: "none" - node-id-or-name: - type: "string" - description: "none" - topology-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.connectivity.getconnectionendpointdetails.Output: type: "object" properties: @@ -19033,9 +18352,16 @@ definitions: tapi.connectivity.getconnectivityservicedetails.Input: type: "object" properties: - service-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.connectivity.getconnectivityservicedetails.Output: type: "object" properties: @@ -19046,22 +18372,38 @@ definitions: allOf: - $ref: "#/definitions/tapi.common.AdminStatePac" - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" - - $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" - - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - type: "object" properties: + topology-constraint: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" end-point: type: "array" description: "none" items: - $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" + $ref: "#/definitions/tapi.connectivity.createconnectivityservice.input.EndPoint" + resilience-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" connection: type: "array" description: "none" items: $ref: "#/definitions/tapi.connectivity.ConnectionRef" + connectivity-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + direction: + description: "none" + $ref: "#/definitions/tapi.common.ForwardingDirection" description: "none" tapi.connectivity.getconnectivityservicelist.Output: type: "object" @@ -19075,49 +18417,81 @@ definitions: allOf: - $ref: "#/definitions/tapi.common.AdminStatePac" - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" - - $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" - - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - type: "object" properties: + topology-constraint: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" end-point: type: "array" description: "none" items: - $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" + $ref: "#/definitions/tapi.connectivity.createconnectivityservice.input.EndPoint" + resilience-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" connection: type: "array" description: "none" items: $ref: "#/definitions/tapi.connectivity.ConnectionRef" + connectivity-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + direction: + description: "none" + $ref: "#/definitions/tapi.common.ForwardingDirection" description: "none" tapi.connectivity.updateconnectivityservice.Input: type: "object" properties: - service-id-or-name: - type: "string" - description: "none" topology-constraint: + type: "array" description: "none" - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" end-point: type: "array" description: "none" items: - $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" + $ref: "#/definitions/tapi.connectivity.createconnectivityservice.input.EndPoint" resilience-constraint: description: "none" $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" routing-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.RoutingConstraint" state: - type: "string" description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" connectivity-constraint: description: "none" $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.connectivity.updateconnectivityservice.Output: type: "object" properties: @@ -19128,45 +18502,45 @@ definitions: allOf: - $ref: "#/definitions/tapi.common.AdminStatePac" - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" - - $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" - - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - type: "object" properties: + topology-constraint: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" end-point: type: "array" description: "none" items: - $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" + $ref: "#/definitions/tapi.connectivity.createconnectivityservice.input.EndPoint" + resilience-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" connection: type: "array" description: "none" items: $ref: "#/definitions/tapi.connectivity.ConnectionRef" + connectivity-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + direction: + description: "none" + $ref: "#/definitions/tapi.common.ForwardingDirection" description: "none" - tapi.notification.AlarmInfo: - type: "object" - properties: - perceived-severity: - description: "none" - $ref: "#/definitions/tapi.notification.PerceivedSeverityType" - probable-cause: - type: "string" - description: "none" - service-affecting: - description: "none" - $ref: "#/definitions/tapi.notification.ServiceAffecting" - is-transient: - type: "boolean" - description: "none" - default: false - tapi.notification.ContextAugmentation2: + tapi.notification.ContextAugmentation1: type: "object" properties: notification-context: description: "Augments the base TAPI Context with NotificationService information" - $ref: "#/definitions/tapi.notification.NotificationContext" + $ref: "#/definitions/tapi.notification.context.NotificationContext" x-augmentation: prefix: "tapi-notification" namespace: "urn:onf:otcc:yang:tapi-notification" @@ -19175,11 +18549,6 @@ definitions: properties: output: $ref: "#/definitions/tapi.notification.createnotificationsubscriptionservice.Output" - tapi.notification.DeleteNotificationSubscriptionService: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.notification.deletenotificationsubscriptionservice.Output" tapi.notification.GetNotificationList: type: "object" properties: @@ -19218,8 +18587,8 @@ definitions: - type: "object" properties: target-object-type: + type: "string" description: "none" - $ref: "#/definitions/tapi.notification.ObjectType" additional-text: type: "string" description: "none" @@ -19235,18 +18604,15 @@ definitions: type: "integer" format: "int32" description: "A monotonous increasing sequence number associated with the\ - \ notification.\r\n The exact semantics of how this\ - \ sequence number is assigned (per channel or subscription or source or\ - \ system) is left undefined." - tca-info: - description: "none" - $ref: "#/definitions/tapi.notification.TcaInfo" + \ notification.\r\n The exact semantics of how this sequence\ + \ number is assigned (per channel or subscription or source or system)\ + \ is left undefined." target-object-identifier: type: "string" description: "none" notification-type: + type: "string" description: "none" - $ref: "#/definitions/tapi.notification.NotificationType" target-object-name: type: "array" description: "none" @@ -19258,9 +18624,9 @@ definitions: source-indicator: description: "none" $ref: "#/definitions/tapi.notification.SourceIndicator" - alarm-info: + layer-protocol-qualifier: + type: "string" description: "none" - $ref: "#/definitions/tapi.notification.AlarmInfo" changed-attributes: type: "array" description: "none" @@ -19280,23 +18646,10 @@ definitions: stream-address: type: "string" description: "The address/location/URI of the channel/stream to which the\ - \ subscribed notifications are published.\r\n This\ - \ specifics of this is typically dependent on the implementation protocol\ - \ & mechanism and hence is typed as a string." + \ subscribed notifications are published.\r\n This specifics\ + \ of this is typically dependent on the implementation protocol & mechanism\ + \ and hence is typed as a string." description: "none" - tapi.notification.NotificationContext: - type: "object" - properties: - notif-subscription: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - notification: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.Notification" tapi.notification.NotificationSubscriptionService: allOf: - $ref: "#/definitions/tapi.common.GlobalClass" @@ -19317,68 +18670,16 @@ definitions: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.ObjectType" + type: "string" supported-notification-types: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.NotificationType" + type: "string" subscription-filter: description: "none" $ref: "#/definitions/tapi.notification.SubscriptionFilter" description: "none" - tapi.notification.NotificationType: - type: "string" - enum: - - "OBJECT_CREATION" - - "OBJECT_DELETION" - - "ATTRIBUTE_VALUE_CHANGE" - - "ALARM_EVENT" - - "THRESHOLD_CROSSING_ALERT" - tapi.notification.ObjectType: - type: "string" - enum: - - "TOPOLOGY" - - "NODE" - - "LINK" - - "CONNECTION" - - "PATH" - - "CONNECTIVITY_SERVICE" - - "VIRTUAL_NETWORK_SERVICE" - - "PATH_COMPUTATION_SERVICE" - - "NODE_EDGE_POINT" - - "SERVICE_INTERFACE_POINT" - - "CONNECTION_END_POINT" - - "MAINTENANCE_ENTITY_GROUP" - - "MAINTENANCE_ENTITY" - - "MEG_END_POINT" - - "MEG_INTERMEDIATE_POINT" - - "SWITCH_CONTROL" - - "SWITCH" - - "ROUTE" - - "NODE_RULE_GROUP" - - "INTER_RULE_GROUP" - - "RULE" - - "OAM_JOB" - tapi.notification.PerceivedSeverityType: - type: "string" - enum: - - "CRITICAL" - - "MAJOR" - - "MINOR" - - "WARNING" - - "CLEARED" - tapi.notification.PerceivedTcaSeverity: - type: "string" - enum: - - "WARNING" - - "CLEAR" - tapi.notification.ServiceAffecting: - type: "string" - enum: - - "SERVICE_AFFECTING" - - "NOT_SERVICE_AFFECTING" - - "UNKNOWN" tapi.notification.SourceIndicator: type: "string" enum: @@ -19394,7 +18695,7 @@ definitions: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.NotificationType" + type: "string" requested-object-identifier: type: "array" description: "none" @@ -19415,57 +18716,56 @@ definitions: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.ObjectType" + type: "string" description: "none" tapi.notification.SubscriptionState: type: "string" enum: - "SUSPENDED" - "ACTIVE" - tapi.notification.TcaInfo: - type: "object" - properties: - threshold-crossing: - description: "none" - $ref: "#/definitions/tapi.notification.ThresholdCrossingType" - threshold-parameter: - type: "string" - description: "none" - is-transient: - type: "boolean" - description: "none" - default: false - threshold-value: - type: "integer" - format: "int32" - description: "none" - perceived-severity: - description: "none" - $ref: "#/definitions/tapi.notification.PerceivedTcaSeverity" - suspect-interval-flag: - type: "boolean" - description: "none" - default: false - measurement-interval: - type: "string" - description: "none" - tapi.notification.ThresholdCrossingType: - type: "string" - enum: - - "THRESHOLD_ABOVE" - - "THRESHOLD_BELOW" - - "CLEARED" tapi.notification.UpdateNotificationSubscriptionService: type: "object" properties: output: $ref: "#/definitions/tapi.notification.updatenotificationsubscriptionservice.Output" + tapi.notification.context.NotificationContext: + allOf: + - type: "object" + properties: + notif-subscription: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + notification: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.notificationcontext.Notification" + description: "Augments the base TAPI Context with NotificationService information" tapi.notification.createnotificationsubscriptionservice.Input: type: "object" properties: subscription-state: description: "none" $ref: "#/definitions/tapi.notification.SubscriptionState" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" subscription-filter: description: "none" $ref: "#/definitions/tapi.notification.SubscriptionFilter" @@ -19478,24 +18778,33 @@ definitions: tapi.notification.deletenotificationsubscriptionservice.Input: type: "object" properties: - subscription-id-or-name: + uuid: type: "string" - description: "none" - tapi.notification.deletenotificationsubscriptionservice.Output: - type: "object" - properties: - subscription-service: - description: "none" - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.notification.getnotificationlist.Input: type: "object" properties: - time-period: - type: "string" - description: "none" - subscription-id-or-name: - type: "string" + time-range: description: "none" + $ref: "#/definitions/tapi.common.TimeRange" + subscription-id: + type: "string" + description: "UUID of the associated Notification Subscription Service: An\ + \ identifier that is universally unique within an identifier space, where\ + \ the identifier space is itself globally unique, and immutable.\r\n \ + \ An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.notification.getnotificationlist.Output: type: "object" properties: @@ -19503,13 +18812,20 @@ definitions: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.Notification" + $ref: "#/definitions/tapi.notification.notificationcontext.Notification" tapi.notification.getnotificationsubscriptionservicedetails.Input: type: "object" properties: - subscription-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.notification.getnotificationsubscriptionservicedetails.Output: type: "object" properties: @@ -19531,31 +18847,66 @@ definitions: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.ObjectType" + type: "string" supported-notification-types: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.NotificationType" + type: "string" + tapi.notification.notificationcontext.Notification: + allOf: + - $ref: "#/definitions/tapi.notification.Notification" + - $ref: "#/definitions/tapi.oam.NotificationAugmentation1" + - $ref: "#/definitions/tapi.oam.NotificationAugmentation2" tapi.notification.updatenotificationsubscriptionservice.Input: type: "object" properties: subscription-state: description: "none" $ref: "#/definitions/tapi.notification.SubscriptionState" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" subscription-filter: description: "none" $ref: "#/definitions/tapi.notification.SubscriptionFilter" - subscription-id-or-name: - type: "string" - description: "none" tapi.notification.updatenotificationsubscriptionservice.Output: type: "object" properties: subscription-service: description: "none" $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - tapi.oam.ConnectionEndPointAugmentation2: + tapi.oam.AlarmInfo: + type: "object" + properties: + perceived-severity: + description: "none" + $ref: "#/definitions/tapi.oam.PerceivedSeverityType" + probable-cause: + type: "string" + description: "none" + service-affecting: + description: "none" + $ref: "#/definitions/tapi.oam.ServiceAffecting" + is-transient: + type: "boolean" + description: "none" + default: false + tapi.oam.ConnectionEndPointAugmentation4: type: "object" properties: mep-mip-list: @@ -19564,12 +18915,12 @@ definitions: x-augmentation: prefix: "tapi-oam" namespace: "urn:onf:otcc:yang:tapi-oam" - tapi.oam.ContextAugmentation1: + tapi.oam.ContextAugmentation3: type: "object" properties: oam-context: description: "Augments the base TAPI Context with OamService information" - $ref: "#/definitions/tapi.oam.OamContext" + $ref: "#/definitions/tapi.oam.context.OamContext" x-augmentation: prefix: "tapi-oam" namespace: "urn:onf:otcc:yang:tapi-oam" @@ -19578,16 +18929,47 @@ definitions: properties: output: $ref: "#/definitions/tapi.oam.createoamjob.Output" + tapi.oam.CreateOamProfile: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.createoamprofile.Output" tapi.oam.CreateOamService: type: "object" properties: output: $ref: "#/definitions/tapi.oam.createoamservice.Output" - tapi.oam.CreateOamServiceEndPoint: + tapi.oam.CreateOamServicePoint: type: "object" properties: output: - $ref: "#/definitions/tapi.oam.createoamserviceendpoint.Output" + $ref: "#/definitions/tapi.oam.createoamservicepoint.Output" + tapi.oam.CurrentData: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + elapsed-time: + description: "none" + $ref: "#/definitions/tapi.common.TimeInterval" + period-start-time: + type: "string" + description: "This attribute indicates the start of the current monitoring\ + \ interval.\r\n The value is bound to the quarter of an\ + \ hour in case of a 15 minute interval and bound to the hour in case of\ + \ a 24 hour interval." + pm-data-pac: + description: "none" + $ref: "#/definitions/tapi.oam.PmDataPac" + history-data: + type: "array" + description: "in case of 24hr Current Data, at least 1 History Data.\r\n\ + \ In case of 15min Current Data, at least 16 History Data.\r\ + \n In case of <15min, the number of History Data shall\ + \ be able to cover a span of 4 hours." + items: + $ref: "#/definitions/tapi.oam.HistoryData" + description: "none" tapi.oam.GetMeg: type: "object" properties: @@ -19598,53 +18980,75 @@ definitions: properties: output: $ref: "#/definitions/tapi.oam.getoamjob.Output" - tapi.oam.GetOamService: + tapi.oam.GetOamJobList: type: "object" properties: output: - $ref: "#/definitions/tapi.oam.getoamservice.Output" - tapi.oam.GetOamServiceEndPoint: + $ref: "#/definitions/tapi.oam.getoamjoblist.Output" + tapi.oam.GetOamProfile: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getoamprofile.Output" + tapi.oam.GetOamProfileList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getoamprofilelist.Output" + tapi.oam.GetOamService: type: "object" properties: output: - $ref: "#/definitions/tapi.oam.getoamserviceendpoint.Output" + $ref: "#/definitions/tapi.oam.getoamservice.Output" tapi.oam.GetOamServiceList: type: "object" properties: output: $ref: "#/definitions/tapi.oam.getoamservicelist.Output" - tapi.oam.Meg: + tapi.oam.GetOamServicePoint: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getoamservicepoint.Output" + tapi.oam.HistoryData: allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.common.OperationalStatePac" + - $ref: "#/definitions/tapi.common.LocalClass" - type: "object" properties: - meg-identifier: + period-start-time: type: "string" + description: "This attribute indicates the start of the monitoring interval.\r\ + \n The value is bound to the quarter of an hour in case\ + \ of a 15 minute interval and bound to the hour in case of a 24 hour interval." + pm-data-pac: description: "none" - meg-level: - type: "integer" - format: "int32" + $ref: "#/definitions/tapi.oam.PmDataPac" + period-end-time: + type: "string" description: "none" - mip: - type: "array" - description: "ME may 0, 1, or more MIPs" - items: - $ref: "#/definitions/tapi.oam.Mip" + description: "none" + tapi.oam.Meg: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.common.OperationalStatePac" + - type: "object" + properties: layer-protocol-name: description: "none" $ref: "#/definitions/tapi.common.LayerProtocolName" mep: type: "array" description: "1. ME may have 0 MEPs (case of transit domains where at least\ - \ 1 MIP is present)\r\n 2. ME may have 1 MEP (case\ - \ of edge domaind, where the peer MEP is ouside the managed domain)\r\n\ - \ 3. ME may have 2 MEPs" + \ 1 MIP is present)\r\n 2. ME may have 1 MEP (case of edge\ + \ domaind, where the peer MEP is ouside the managed domain)\r\n \ + \ 3. ME may have 2 MEPs" items: $ref: "#/definitions/tapi.oam.Mep" - direction: - description: "none" - $ref: "#/definitions/tapi.common.ForwardingDirection" + mip: + type: "array" + description: "ME may 0, 1, or more MIPs" + items: + $ref: "#/definitions/tapi.oam.Mip" description: "none" tapi.oam.MegRef: type: "object" @@ -19662,17 +19066,6 @@ definitions: layer-protocol-name: description: "none" $ref: "#/definitions/tapi.common.LayerProtocolName" - peer-mep-identifier: - type: "array" - description: "none" - items: - type: "string" - mep-identifier: - type: "string" - description: "none" - direction: - description: "none" - $ref: "#/definitions/tapi.common.TerminationDirection" description: "none" tapi.oam.MepMipList: type: "object" @@ -19716,42 +19109,24 @@ definitions: description: "none" x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:meg/tapi-oam:mip/tapi-oam:local-id" description: "none" - tapi.oam.OamConstraint: + tapi.oam.NotificationAugmentation1: type: "object" properties: - layer-protocol-name: - description: "none" - $ref: "#/definitions/tapi.common.LayerProtocolName" - meg-level: - type: "integer" - format: "int32" + tca-info: description: "none" - direction: - description: "none" - $ref: "#/definitions/tapi.common.ForwardingDirection" - tapi.oam.OamContext: + $ref: "#/definitions/tapi.oam.TcaInfo" + x-augmentation: + prefix: "tapi-oam" + namespace: "urn:onf:otcc:yang:tapi-oam" + tapi.oam.NotificationAugmentation2: type: "object" properties: - oam-service: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamService" - oam-profile: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamProfile" - oam-job: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamJob" - meg: - type: "array" + alarm-info: description: "none" - items: - $ref: "#/definitions/tapi.oam.Meg" + $ref: "#/definitions/tapi.oam.AlarmInfo" + x-augmentation: + prefix: "tapi-oam" + namespace: "urn:onf:otcc:yang:tapi-oam" tapi.oam.OamJob: allOf: - $ref: "#/definitions/tapi.common.AdminStatePac" @@ -19764,27 +19139,34 @@ definitions: oam-profile: description: "none" $ref: "#/definitions/tapi.oam.OamProfileRef" - pm-current-data: - type: "array" - description: "Granularity period of the CurrentData identifies the specific\ - \ CurrentData instance in the scope of this OamJob.\r\n \ - \ For example, typically at least\r\n one 15min\ - \ and\r\n one 24hr;\r\n optionally\ - \ one additional configurable (< 15min)" - items: - $ref: "#/definitions/tapi.oam.PmCurrentData" creation-time: type: "string" description: "none" - oam-service-end-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamServiceEndPointRef" oam-job-type: type: "string" description: "none" + oam-service-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamServicePointRef" + current-data: + type: "array" + description: "Granularity period of the CurrentData identifies the specific\ + \ CurrentData instance in the scope of this OamJob.\r\n \ + \ For example, typically at least\r\n one 15min and\r\n\ + \ one 24hr;\r\n optionally one additional\ + \ configurable (< 15min)" + items: + $ref: "#/definitions/tapi.oam.CurrentData" description: "none" + tapi.oam.OamJobRef: + type: "object" + properties: + oam-job-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-job/tapi-oam:uuid" tapi.oam.OamProfile: allOf: - $ref: "#/definitions/tapi.common.GlobalClass" @@ -19795,11 +19177,6 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.oam.PmThresholdData" - pm-bin-data: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.PmBinData" description: "none" tapi.oam.OamProfileRef: type: "object" @@ -19812,37 +19189,26 @@ definitions: allOf: - $ref: "#/definitions/tapi.common.AdminStatePac" - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.oam.OamConstraint" - type: "object" properties: - oam-profile: + layer-protocol-name: description: "none" - $ref: "#/definitions/tapi.oam.OamProfileRef" - end-point: + $ref: "#/definitions/tapi.common.LayerProtocolName" + oam-service-point: type: "array" description: "none" items: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" + $ref: "#/definitions/tapi.oam.OamServicePoint" meg: description: "none" $ref: "#/definitions/tapi.oam.MegRef" description: "none" - tapi.oam.OamServiceEndPoint: + tapi.oam.OamServicePoint: allOf: - $ref: "#/definitions/tapi.common.AdminStatePac" - $ref: "#/definitions/tapi.common.LocalClass" - type: "object" properties: - peer-mep-identifier: - type: "array" - description: "This attribute models the MI_PeerMEP_ID[i] defined in G.8021\ - \ and configured as specified in G.8051. It provides the identifiers of\ - \ the MEPs which are peer to the subject MEP.\r\n This\ - \ attribute is not specified in case the OSEP relates to the provisioing\ - \ of an MIP.\r\n In case of P2P, there is only one\ - \ peer" - items: - type: "string" connectivity-service-end-point: description: "none" $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" @@ -19852,30 +19218,27 @@ definitions: service-interface-point: description: "none" $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + is-mip: + type: "boolean" + description: "If true, the object is related to a MIP.\r\n \ + \ If false, the object is related to a MEP." + default: false layer-protocol-name: description: "none" $ref: "#/definitions/tapi.common.LayerProtocolName" mep: description: "none" $ref: "#/definitions/tapi.oam.MepRef" - mep-identifier: - type: "string" - description: "This attribute contains the identifier of the MEP.\r\n \ - \ This attribute is empty in case the OSEP relates to\ - \ the provisioing of an MIP.\r\n " - direction: - description: "none" - $ref: "#/definitions/tapi.common.PortDirection" description: "none" - tapi.oam.OamServiceEndPointRef: + tapi.oam.OamServicePointRef: allOf: - $ref: "#/definitions/tapi.oam.OamServiceRef" - type: "object" properties: - oam-service-end-point-local-id: + oam-service-point-local-id: type: "string" description: "none" - x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-service/tapi-oam:end-point/tapi-oam:local-id" + x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-service/tapi-oam:oam-service-point/tapi-oam:local-id" description: "none" tapi.oam.OamServiceRef: type: "object" @@ -19883,8 +19246,50 @@ definitions: oam-service-uuid: type: "string" description: "none" - x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-service/tapi-oam:uuid" - tapi.oam.PmBinData: + x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-service/tapi-oam:uuid" + tapi.oam.PerceivedSeverityType: + type: "string" + enum: + - "CRITICAL" + - "MAJOR" + - "MINOR" + - "WARNING" + - "CLEARED" + tapi.oam.PerceivedTcaSeverity: + type: "string" + enum: + - "WARNING" + - "CLEAR" + tapi.oam.PmDataPac: + type: "object" + properties: + suspect-interval-flag: + type: "boolean" + description: "This attribute is used to indicate that the performance data\ + \ for the current period may not be reliable. Some reasons for this to occur\ + \ are:\r\n Suspect data were detected by the actual resource\ + \ doing data collection.\r\n Transition of the administrativeState\ + \ attribute to/from the 'lock' state.\r\n Transition of\ + \ the operationalState to/from the 'disabled' state.\r\n \ + \ Scheduler setting that inhibits the collection function.\r\n \ + \ The performance counters were reset during the interval.\r\n\ + \ The currentData (or subclass) object instance was created\ + \ during the monitoring period." + default: false + granularity-period: + description: "none" + $ref: "#/definitions/tapi.common.TimePeriod" + tapi.oam.PmParameterValue: + type: "object" + properties: + pm-parameter-int-value: + type: "integer" + format: "int32" + description: "none" + pm-parameter-real-value: + type: "string" + description: "none" + tapi.oam.PmThresholdData: allOf: - $ref: "#/definitions/tapi.common.LocalClass" - type: "object" @@ -19892,199 +19297,393 @@ definitions: granularity-period: description: "none" $ref: "#/definitions/tapi.common.TimePeriod" - description: "none" - tapi.oam.PmCurrentData: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - elapsed-time: - description: "none" - $ref: "#/definitions/tapi.common.TimeInterval" - pm-history-data: + threshold-parameter: type: "array" - description: "in case of 24hr Current Data, at least 1 History Data.\r\n\ - \ In case of 15min Current Data, at least 16 History\ - \ Data.\r\n In case of <15min, the number of History\ - \ Data shall be able to cover a span of 4 hours." - items: - $ref: "#/definitions/tapi.oam.PmHistoryData" - granularity-period: - description: "none" - $ref: "#/definitions/tapi.common.TimePeriod" - suspect-interval-flag: - type: "boolean" - description: "This attribute is used to indicate that the performance data\ - \ for the current period may not be reliable. Some reasons for this to\ - \ occur are:\r\n Suspect data were detected by the\ - \ actual resource doing data collection.\r\n Transition\ - \ of the administrativeState attribute to/from the 'lock' state.\r\n \ - \ Transition of the operationalState to/from the 'disabled'\ - \ state.\r\n Scheduler setting that inhibits the\ - \ collection function.\r\n The performance counters\ - \ were reset during the interval.\r\n The currentData\ - \ (or subclass) object instance was created during the monitoring period." - default: false - timestamp: - type: "string" - description: "This attribute indicates the start of the current monitoring\ - \ interval.\r\n The value is bound to the quarter of\ - \ an hour in case of a 15 minute interval and bound to the hour in case\ - \ of a 24 hour interval." - description: "none" - tapi.oam.PmHistoryData: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - granularity-period: - description: "none" - $ref: "#/definitions/tapi.common.TimePeriod" - period-end-time: - type: "string" description: "none" - suspect-interval-flag: - type: "boolean" - description: "This attribute indicates that the performance data may not\ - \ be reliable." - default: false - description: "none" - tapi.oam.PmThresholdData: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: + items: + $ref: "#/definitions/tapi.oam.ThresholdParameter" is-transient: type: "boolean" description: "none" default: false - granularity-period: - description: "none" - $ref: "#/definitions/tapi.common.TimePeriod" + applicable-job-type: + type: "array" + description: "This attribute allows an PMThresholdData instance to be constrained\ + \ to specific job types. If an PMThresholdData instance is so configured\ + \ to be applicable to more than one job type (worst case ALL), only the\ + \ parameters relevant for the job instance will be used (non-applicable\ + \ profile parameters will be ignored)" + items: + type: "string" description: "none" + tapi.oam.ServiceAffecting: + type: "string" + enum: + - "SERVICE_AFFECTING" + - "NOT_SERVICE_AFFECTING" + - "UNKNOWN" + tapi.oam.TcaInfo: + type: "object" + properties: + oam-job: + description: "MEF 35.1\r\n Identification of the PM Session\ + \ for which the TCA Function was configured." + $ref: "#/definitions/tapi.oam.OamJobRef" + threshold-parameter: + description: "none" + $ref: "#/definitions/tapi.oam.ThresholdParameter" + is-transient: + type: "boolean" + description: "none" + default: false + perceived-severity: + description: "none" + $ref: "#/definitions/tapi.oam.PerceivedTcaSeverity" + suspect-interval-flag: + type: "boolean" + description: "none" + default: false + measurement-interval: + type: "string" + description: "none" + tapi.oam.ThresholdCrossingQualifier: + type: "string" + enum: + - "NOT_APPLICABLE" + - "NEAR_END" + - "FAR_END" + - "BIDIRECTIONAL" + - "FORWARD" + - "BACKWARD" + tapi.oam.ThresholdParameter: + type: "object" + properties: + pm-parameter-below-thrs: + description: "none" + $ref: "#/definitions/tapi.oam.PmParameterValue" + pm-parameter-clear-thrs: + description: "none" + $ref: "#/definitions/tapi.oam.PmParameterValue" + pm-parameter-above-thrs: + description: "none" + $ref: "#/definitions/tapi.oam.PmParameterValue" + pm-parameter-name: + type: "string" + description: "none" + threshold-location: + description: "none" + $ref: "#/definitions/tapi.oam.ThresholdCrossingQualifier" tapi.oam.UpdateOamJob: type: "object" properties: output: $ref: "#/definitions/tapi.oam.updateoamjob.Output" + tapi.oam.UpdateOamProfile: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.updateoamprofile.Output" tapi.oam.UpdateOamService: type: "object" properties: output: $ref: "#/definitions/tapi.oam.updateoamservice.Output" - tapi.oam.UpdateOamServiceEndPoint: + tapi.oam.UpdateOamServicePoint: type: "object" properties: output: - $ref: "#/definitions/tapi.oam.updateoamserviceendpoint.Output" + $ref: "#/definitions/tapi.oam.updateoamservicepoint.Output" + tapi.oam.context.OamContext: + allOf: + - type: "object" + properties: + oam-service: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamService" + oam-profile: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamProfile" + oam-job: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamJob" + meg: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.oamcontext.Meg" + description: "Augments the base TAPI Context with OamService information" tapi.oam.createoamjob.Input: type: "object" properties: schedule: - type: "string" description: "none" - oam-service-end-point: + $ref: "#/definitions/tapi.common.TimeRange" + name: type: "array" - description: "none" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." items: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" + $ref: "#/definitions/tapi.common.NameAndValue" + oam-service-point-id: + type: "string" + description: "UUID of the associated OSEPs: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" oam-job-type: type: "string" description: "none" - oam-profile: - description: "none" - $ref: "#/definitions/tapi.oam.OamProfile" state: - type: "string" description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + oam-profile-id: + type: "string" + description: "UUID of the OamProfile to be applied: An identifier that is\ + \ universally unique within an identifier space, where the identifier space\ + \ is itself globally unique, and immutable.\r\n An UUID\ + \ carries no semantics with respect to the purpose or state of the entity.\r\ + \n UUID here uses string representation as defined in\ + \ RFC 4122. The canonical representation uses lowercase characters.\r\n\ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + oam-service-id: + type: "string" + description: "UUID of the associated OamService: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.oam.createoamjob.Output: type: "object" properties: oam-job: description: "none" $ref: "#/definitions/tapi.oam.OamJob" - tapi.oam.createoamservice.Input: + tapi.oam.createoamprofile.Input: type: "object" properties: - oam-constraint: - description: "none" - $ref: "#/definitions/tapi.oam.OamConstraint" - state: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: type: "string" - description: "none" - end-point: + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + pm-threshold-data: type: "array" description: "none" items: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - tapi.oam.createoamservice.Output: + $ref: "#/definitions/tapi.oam.PmThresholdData" + tapi.oam.createoamprofile.Output: type: "object" properties: - service: + oam-profile: description: "none" - $ref: "#/definitions/tapi.oam.OamService" - tapi.oam.createoamserviceendpoint.Input: + $ref: "#/definitions/tapi.oam.OamProfile" + tapi.oam.createoamservice.Input: type: "object" properties: - peer-mep-identifier: - type: "array" + layer-protocol-name: description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." items: - type: "string" - service-id: - type: "string" + $ref: "#/definitions/tapi.common.NameAndValue" + oam-service-point: + type: "array" description: "none" - sip-id: - type: "string" + items: + $ref: "#/definitions/tapi.oam.OamServicePoint" + state: description: "none" - c-sep-id: + $ref: "#/definitions/tapi.common.AdministrativeState" + uuid: type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.createoamservice.Output: + type: "object" + properties: + oam-service: description: "none" - mep-identifier: - type: "string" + $ref: "#/definitions/tapi.oam.OamService" + tapi.oam.createoamservicepoint.Input: + type: "object" + properties: + layer-protocol-name: description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" state: - type: "string" - description: "none" - layer: - type: "string" description: "none" - direction: + $ref: "#/definitions/tapi.common.AdministrativeState" + connectivity-service-end-point-id: + type: "string" + description: "UUID of the CSEP to be monitored: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + service-interface-point-id: + type: "string" + description: "UUID of the associated SIP to be monitored: An identifier that\ + \ is universally unique within an identifier space, where the identifier\ + \ space is itself globally unique, and immutable.\r\n \ + \ An UUID carries no semantics with respect to the purpose or state of\ + \ the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + oam-service-id: + type: "string" + description: "UUID of the parent OamService: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + uuid: type: "string" - description: "none" - tapi.oam.createoamserviceendpoint.Output: + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.createoamservicepoint.Output: type: "object" properties: - end-point: + oam-service-point: description: "none" - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" + $ref: "#/definitions/tapi.oam.OamServicePoint" tapi.oam.deleteoamjob.Input: type: "object" properties: - job-id: + uuid: type: "string" - description: "none" - tapi.oam.deleteoamservice.Input: + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.deleteoamprofile.Input: type: "object" properties: - service-id: + uuid: type: "string" - description: "none" - tapi.oam.deleteoamserviceendpoint.Input: + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.deleteoamservice.Input: type: "object" properties: - service-id: + uuid: type: "string" - description: "none" - o-sep-id: + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.deleteoamservicepoint.Input: + type: "object" + properties: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.oam.getmeg.Input: type: "object" properties: - service-id: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.oam.getmeg.Output: type: "object" properties: @@ -20094,50 +19693,103 @@ definitions: tapi.oam.getoamjob.Input: type: "object" properties: - job-id: - type: "string" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.getoamjob.Output: + type: "object" + properties: + oam-job: + description: "none" + $ref: "#/definitions/tapi.oam.OamJob" + tapi.oam.getoamjoblist.Output: + type: "object" + properties: + oam-job: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamJob" + tapi.oam.getoamprofile.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.getoamprofile.Output: + type: "object" + properties: + oam-profile: description: "none" - tapi.oam.getoamjob.Output: + $ref: "#/definitions/tapi.oam.OamProfile" + tapi.oam.getoamprofilelist.Output: type: "object" properties: - oam-job: + oam-profile: + type: "array" description: "none" - $ref: "#/definitions/tapi.oam.OamJob" + items: + $ref: "#/definitions/tapi.oam.OamProfile" tapi.oam.getoamservice.Input: type: "object" properties: - service-id: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.oam.getoamservice.Output: type: "object" properties: - service: + oam-service: description: "none" $ref: "#/definitions/tapi.oam.OamService" - tapi.oam.getoamserviceendpoint.Input: + tapi.oam.getoamservicelist.Output: type: "object" properties: - service-id: - type: "string" - description: "none" - o-sep-id: - type: "string" + oam-service: + type: "array" description: "none" - tapi.oam.getoamserviceendpoint.Output: + items: + $ref: "#/definitions/tapi.oam.OamService" + tapi.oam.getoamservicepoint.Input: type: "object" properties: - end-point: - description: "none" - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - tapi.oam.getoamservicelist.Output: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.getoamservicepoint.Output: type: "object" properties: - service: - type: "array" + oam-service-point: description: "none" - items: - $ref: "#/definitions/tapi.oam.OamService" + $ref: "#/definitions/tapi.oam.OamServicePoint" tapi.oam.meg.Mep: allOf: - $ref: "#/definitions/tapi.oam.Mep" @@ -20150,98 +19802,164 @@ definitions: allOf: - $ref: "#/definitions/tapi.common.GlobalClass" - $ref: "#/definitions/tapi.common.OperationalStatePac" + - $ref: "#/definitions/tapi.odu.MegAugmentation1" - type: "object" properties: - meg-identifier: - type: "string" - description: "none" - meg-level: - type: "integer" - format: "int32" - description: "none" - mip: - type: "array" - description: "ME may 0, 1, or more MIPs" - items: - $ref: "#/definitions/tapi.oam.meg.Mip" layer-protocol-name: description: "none" $ref: "#/definitions/tapi.common.LayerProtocolName" mep: type: "array" description: "1. ME may have 0 MEPs (case of transit domains where at least\ - \ 1 MIP is present)\r\n 2. ME may have 1 MEP (case\ - \ of edge domaind, where the peer MEP is ouside the managed domain)\r\n\ - \ 3. ME may have 2 MEPs" + \ 1 MIP is present)\r\n 2. ME may have 1 MEP (case of edge\ + \ domaind, where the peer MEP is ouside the managed domain)\r\n \ + \ 3. ME may have 2 MEPs" items: $ref: "#/definitions/tapi.oam.meg.Mep" - direction: - description: "none" - $ref: "#/definitions/tapi.common.ForwardingDirection" + mip: + type: "array" + description: "ME may 0, 1, or more MIPs" + items: + $ref: "#/definitions/tapi.oam.meg.Mip" description: "none" tapi.oam.updateoamjob.Input: type: "object" properties: - job-id: - type: "string" - description: "none" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" schedule: - type: "string" - description: "none" - oam-profile: description: "none" - $ref: "#/definitions/tapi.oam.OamProfile" + $ref: "#/definitions/tapi.common.TimeRange" state: - type: "string" description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + oam-profile-id: + type: "string" + description: "UUID of the OamProfile to be applied: An identifier that is\ + \ universally unique within an identifier space, where the identifier space\ + \ is itself globally unique, and immutable.\r\n An UUID\ + \ carries no semantics with respect to the purpose or state of the entity.\r\ + \n UUID here uses string representation as defined in\ + \ RFC 4122. The canonical representation uses lowercase characters.\r\n\ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.oam.updateoamjob.Output: type: "object" properties: oam-job: description: "none" $ref: "#/definitions/tapi.oam.OamJob" - tapi.oam.updateoamservice.Input: + tapi.oam.updateoamprofile.Input: type: "object" properties: - oam-constraint: - description: "none" - $ref: "#/definitions/tapi.oam.OamConstraint" - service-id: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + pm-threshold-data: + type: "array" description: "none" - state: - type: "string" + items: + $ref: "#/definitions/tapi.oam.PmThresholdData" + tapi.oam.updateoamprofile.Output: + type: "object" + properties: + oam-profile: description: "none" - end-point: + $ref: "#/definitions/tapi.oam.OamProfile" + tapi.oam.updateoamservice.Input: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + oam-service-point: type: "array" description: "none" items: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" + $ref: "#/definitions/tapi.oam.OamServicePoint" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.oam.updateoamservice.Output: type: "object" properties: - service: + oam-service: description: "none" $ref: "#/definitions/tapi.oam.OamService" - tapi.oam.updateoamserviceendpoint.Input: + tapi.oam.updateoamservicepoint.Input: type: "object" properties: - service-id: - type: "string" - description: "none" - o-sep-id: - type: "string" - description: "none" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" state: - type: "string" description: "none" - tapi.oam.updateoamserviceendpoint.Output: + $ref: "#/definitions/tapi.common.AdministrativeState" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.updateoamservicepoint.Output: type: "object" properties: - end-point: + oam-service-point: description: "none" - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - tapi.odu.ConnectionEndPointAugmentation1: + $ref: "#/definitions/tapi.oam.OamServicePoint" + tapi.odu.ConnectionEndPointAugmentation5: type: "object" properties: odu-connection-end-point-spec: @@ -20268,6 +19986,15 @@ definitions: enum: - "PERCENTAGE" - "NUMBER_ERRORED_BLOCKS" + tapi.odu.EndPointAugmentation3: + type: "object" + properties: + odu-connectivity-service-end-point-spec: + description: "none" + $ref: "#/definitions/tapi.odu.OduConnectivityServiceEndPointSpec" + x-augmentation: + prefix: "tapi-odu" + namespace: "urn:onf:otcc:yang:tapi-odu" tapi.odu.MappingType: type: "string" enum: @@ -20277,12 +20004,21 @@ definitions: - "GMP" - "TTP_GFP_BMP" - "NULL" + tapi.odu.MegAugmentation1: + type: "object" + properties: + odu-meg-spec: + description: "none" + $ref: "#/definitions/tapi.odu.OduMegSpec" + x-augmentation: + prefix: "tapi-odu" + namespace: "urn:onf:otcc:yang:tapi-odu" tapi.odu.MepAugmentation1: type: "object" properties: - odu-connection-end-point-spec: + odu-mep-spec: description: "none" - $ref: "#/definitions/tapi.odu.OduConnectionEndPointSpec" + $ref: "#/definitions/tapi.odu.OduMepSpec" x-augmentation: prefix: "tapi-odu" namespace: "urn:onf:otcc:yang:tapi-odu" @@ -20295,6 +20031,16 @@ definitions: x-augmentation: prefix: "tapi-odu" namespace: "urn:onf:otcc:yang:tapi-odu" + tapi.odu.NodeEdgePointAugmentation3: + type: "object" + properties: + odu-node-edge-point-spec: + description: "Augments the base LayerProtocol information in NodeEdgePoint\ + \ with ODU-specific information" + $ref: "#/definitions/tapi.odu.OduNodeEdgePointSpec" + x-augmentation: + prefix: "tapi-odu" + namespace: "urn:onf:otcc:yang:tapi-odu" tapi.odu.OduCommonPac: type: "object" properties: @@ -20302,17 +20048,16 @@ definitions: type: "integer" format: "int32" description: "This attribute indicates the rate tolerance of the ODU termination\ - \ point. \r\n Valid values are real value in the unit\ - \ of ppm. \r\n Standardized values are defined in Table\ - \ 7-2/G.709." + \ point. \r\n Valid values are real value in the unit of\ + \ ppm. \r\n Standardized values are defined in Table 7-2/G.709." odu-rate: type: "integer" format: "int32" description: "This attribute indicates the rate of the ODU terminatino point.\ - \ \r\n This attribute is Set at create; i.e., once created\ - \ it cannot be changed directly. \r\n In case of resizable\ + \ \r\n This attribute is Set at create; i.e., once created\ + \ it cannot be changed directly. \r\n In case of resizable\ \ ODU flex, its value can be changed via HAO (not directly on the attribute).\ - \ \r\n " + \ \r\n " odu-type: type: "string" description: "This attribute specifies the type of the ODU termination point." @@ -20331,6 +20076,62 @@ definitions: odu-protection: description: "none" $ref: "#/definitions/tapi.odu.OduProtectionPac" + tapi.odu.OduConnectivityServiceEndPointSpec: + type: "object" + properties: + accepted-payload-type: + description: "This attribute is applicable when the ODU CTP object instance\ + \ represents a lower order ODU CTP Sink at the client layer of the ODUP/ODU[i]j\ + \ or ODUP/ODUj-21 adaptation function. \r\n This attribute\ + \ is a 2-digit Hex code that indicates the new accepted payload type.\r\n\ + \ Valid values are defined in Table 15-8 of ITU-T Recommendation\ + \ G.709 with one additional value UN_INTERPRETABLE." + $ref: "#/definitions/tapi.odu.OduPayloadType" + opu-tributary-slot-size: + description: "This attribute is applicable for ODU2 and ODU3 CTP only. It\ + \ indicates the slot size of the ODU CTP." + $ref: "#/definitions/tapi.odu.OduSlotSize" + tributary-port-number: + type: "integer" + format: "int32" + description: "This attribute identifies the tributary port number that is\ + \ associated with the ODU CTP.\r\n range of type : The value\ + \ range depends on the size of the Tributary Port Number (TPN) field used\ + \ which depends on th server-layer ODU or OTU.\r\n In case\ + \ of ODUk mapping into OTUk, there is no TPN field, so the tributaryPortNumber\ + \ shall be zero.\r\n In case of LO ODUj mapping over ODU1,\ + \ ODU2 or ODU3, the TPN is encoded in a 6-bit field so the value range is\ + \ 0-63. See clause 14.4.1/G.709-2016.\r\n In case of LO ODUj\ + \ mapping over ODU4, the TPN is encoded in a 7-bit field so the value range\ + \ is 0-127. See clause 14.4.1.4/G.709-2016.\r\n In case of\ + \ ODUk mapping over ODUCn, the TPN is encoded in a 14-bit field so the value\ + \ range is 0-16383. See clause 20.4.1.1/G.709-2016.\r\n " + tributary-slot-list: + type: "array" + description: "This attribute contains a set of distinct (i.e. unique) integers\ + \ (e.g. 2, 3, 5, 9, 15 representing the tributary slots TS2, TS3, TS5, TS9\ + \ and TS15) which represents the resources occupied by the Low Order ODU\ + \ Link Connection (e.g. carrying an ODUflex with a bit rate of 6.25G). \r\ + \n This attribute applies when the LO ODU_ ConnectionTerminationPoint\ + \ connects with an HO ODU_TrailTerminationPoint object. \r\n \ + \ It will not apply if this ODU_ ConnectionTerminationPoint object directly\ + \ connects to an OTU_TrailTerminationPoint object (i.e. OTU has no trib\ + \ slots). \r\n The upper bound of the integer allowed in\ + \ this set is a function of the HO-ODU server layer to which the ODU connection\ + \ has been mapped (adapted). \r\n Thus, for example, M=8/32/80\ + \ for ODU2/ODU3/ODU4 server layers (respectively). Note that the value of\ + \ this attribute can be changed only in the case of ODUflex and has to be\ + \ through specific operations (i.e. not be changing the attribute tributarySlotList\ + \ directly)." + items: + type: "integer" + format: "int32" + configured-mapping-type: + description: "This attributes indicates the configured mapping type." + $ref: "#/definitions/tapi.odu.MappingType" + odu-type: + type: "string" + description: "This attribute specifies the type of the ODU termination point." tapi.odu.OduCtpPac: type: "object" properties: @@ -20346,35 +20147,34 @@ definitions: type: "integer" format: "int32" description: "This attribute identifies the tributary port number that is\ - \ associated with the ODU CTP.\r\n range of type : The\ - \ value range depends on the size of the Tributary Port Number (TPN) field\ - \ used which depends on th server-layer ODU or OTU.\r\n \ - \ In case of ODUk mapping into OTUk, there is no TPN field, so the tributaryPortNumber\ - \ shall be zero.\r\n In case of LO ODUj mapping over\ - \ ODU1, ODU2 or ODU3, the TPN is encoded in a 6-bit field so the value range\ - \ is 0-63. See clause 14.4.1/G.709-2016.\r\n In case\ - \ of LO ODUj mapping over ODU4, the TPN is encoded in a 7-bit field so the\ - \ value range is 0-127. See clause 14.4.1.4/G.709-2016.\r\n \ - \ In case of ODUk mapping over ODUCn, the TPN is encoded in a 14-bit\ - \ field so the value range is 0-16383. See clause 20.4.1.1/G.709-2016.\r\ - \n " + \ associated with the ODU CTP.\r\n range of type : The value\ + \ range depends on the size of the Tributary Port Number (TPN) field used\ + \ which depends on th server-layer ODU or OTU.\r\n In case\ + \ of ODUk mapping into OTUk, there is no TPN field, so the tributaryPortNumber\ + \ shall be zero.\r\n In case of LO ODUj mapping over ODU1,\ + \ ODU2 or ODU3, the TPN is encoded in a 6-bit field so the value range is\ + \ 0-63. See clause 14.4.1/G.709-2016.\r\n In case of LO ODUj\ + \ mapping over ODU4, the TPN is encoded in a 7-bit field so the value range\ + \ is 0-127. See clause 14.4.1.4/G.709-2016.\r\n In case of\ + \ ODUk mapping over ODUCn, the TPN is encoded in a 14-bit field so the value\ + \ range is 0-16383. See clause 20.4.1.1/G.709-2016.\r\n " tributary-slot-list: type: "array" description: "This attribute contains a set of distinct (i.e. unique) integers\ \ (e.g. 2, 3, 5, 9, 15 representing the tributary slots TS2, TS3, TS5, TS9\ \ and TS15) which represents the resources occupied by the Low Order ODU\ \ Link Connection (e.g. carrying an ODUflex with a bit rate of 6.25G). \r\ - \n This attribute applies when the LO ODU_ ConnectionTerminationPoint\ + \n This attribute applies when the LO ODU_ ConnectionTerminationPoint\ \ connects with an HO ODU_TrailTerminationPoint object. \r\n \ - \ It will not apply if this ODU_ ConnectionTerminationPoint object\ - \ directly connects to an OTU_TrailTerminationPoint object (i.e. OTU has\ - \ no trib slots). \r\n The upper bound of the integer\ - \ allowed in this set is a function of the HO-ODU server layer to which\ - \ the ODU connection has been mapped (adapted). \r\n \ - \ Thus, for example, M=8/32/80 for ODU2/ODU3/ODU4 server layers (respectively).\ - \ Note that the value of this attribute can be changed only in the case\ - \ of ODUflex and has to be through specific operations (i.e. not be changing\ - \ the attribute tributarySlotList directly)." + \ It will not apply if this ODU_ ConnectionTerminationPoint object directly\ + \ connects to an OTU_TrailTerminationPoint object (i.e. OTU has no trib\ + \ slots). \r\n The upper bound of the integer allowed in\ + \ this set is a function of the HO-ODU server layer to which the ODU connection\ + \ has been mapped (adapted). \r\n Thus, for example, M=8/32/80\ + \ for ODU2/ODU3/ODU4 server layers (respectively). Note that the value of\ + \ this attribute can be changed only in the case of ODUflex and has to be\ + \ through specific operations (i.e. not be changing the attribute tributarySlotList\ + \ directly)." items: type: "integer" format: "int32" @@ -20405,6 +20205,57 @@ definitions: type: "boolean" description: "Trail Trace Identifier Mismatch" default: false + tapi.odu.OduMegSpec: + type: "object" + properties: + meg-level: + type: "integer" + format: "int32" + description: "none" + tapi.odu.OduMepPac: + allOf: + - $ref: "#/definitions/tapi.odu.OduMipPac" + - type: "object" + properties: + dm-source: + type: "boolean" + description: "This attribute is for configuring the delay measurement process\ + \ at the trail termination function represented by the subject TTP object\ + \ class. It models the MI_DM_Source MI signal. If MI_DM_Source is false,\ + \ then the value of the DMp bit is determined by the RI_DM. If MI_DM_Source\ + \ is true, then the value of the DMp bit is set to MI_DMValue." + default: false + dm-value: + type: "boolean" + description: "This attribute is for setting the DMp and DMti bits of the\ + \ delay measurement process. The value of 'true' sets the DMp and DMti\ + \ bits to 0 and the value of 'false' to 1." + default: false + txti: + type: "string" + description: "The Trail Trace Identifier (TTI) information, provisioned\ + \ by the managing system at the termination source, to be placed in the\ + \ TTI overhead position of the source of a trail for transmission.\r\n\ + \ " + description: "none" + tapi.odu.OduMepSpec: + type: "object" + properties: + odu-pm: + description: "none" + $ref: "#/definitions/tapi.odu.OduPmPac" + odu-ncm: + description: "none" + $ref: "#/definitions/tapi.odu.OduNcmPac" + odu-mep: + description: "none" + $ref: "#/definitions/tapi.odu.OduMepPac" + odu-tcm: + description: "none" + $ref: "#/definitions/tapi.odu.OduTcmMepPac" + odu-defect: + description: "none" + $ref: "#/definitions/tapi.odu.OduDefectPac" tapi.odu.OduMipPac: type: "object" properties: @@ -20432,7 +20283,7 @@ definitions: description: "The Expected Source Access Point Identifier (ExSAPI), provisioned\ \ by the managing system, to be compared with the TTI accepted at the overhead\ \ position of the sink for the purpose of checking the integrity of connectivity.\r\ - \n " + \n " deg-thr: description: "This attribute indicates the threshold level for declaring a\ \ performance monitoring (PM) Second to be bad. The value of the threshold\ @@ -20559,9 +20410,60 @@ definitions: enum: - "1G25" - "2G5" + tapi.odu.OduTcmMepPac: + type: "object" + properties: + admin-state-sink: + description: "This attribute provides the capability to provision the LOCK\ + \ signal at the sink, which is one of the ODU maintenance signals. When\ + \ a Tandem Connection endpoint is set to admin state locked, it will insert\ + \ the ODU-LCK signal in the downstream direction." + $ref: "#/definitions/tapi.common.AdministrativeState" + codirectional: + type: "boolean" + description: "This attribute specifies the directionality of the ODUT MEP\ + \ with respect to the associated ODU CEP. The value of TRUE means that the\ + \ sink part of the ODUT MEP terminates the same signal direction as the\ + \ sink part of the ODU CEP. The Source part behaves similarly. This attribute\ + \ is meaningful only on objects instantiated under ODU CEP, and at least\ + \ one among ODU CEP and the subordinate object is bidirectional." + default: false + admin-state-source: + description: "This attribute provides the capability to provision the LOCK\ + \ signal at the source, which is one of the ODU maintenance signals. When\ + \ a Tandem Connection endpoint is set to admin state locked, it will insert\ + \ the ODU-LCK signal in the source direction." + $ref: "#/definitions/tapi.common.AdministrativeState" + ac-status-source: + description: "This attribute indicates the status of the accepted TCM. " + $ref: "#/definitions/tapi.odu.TcmStatus" + tcm-extension: + description: "none" + $ref: "#/definitions/tapi.odu.TcmExtension" + ac-status-sink: + description: "This attribute indicates the status of the accepted TCM. " + $ref: "#/definitions/tapi.odu.TcmStatus" + tcm-mode: + description: "This attribute specifies the TCM mode at the entity. Valid values\ + \ are: Operational, Monitor, and Transparent." + $ref: "#/definitions/tapi.odu.TcmMode" + tcm-field: + type: "integer" + format: "int32" + description: "This attribute indicates the tandem connection monitoring field\ + \ of the ODU OH." tapi.odu.OduTcmMipPac: type: "object" properties: + codirectional: + type: "boolean" + description: "This attribute specifies the directionality of the ODU MIP with\ + \ respect to the associated ODU CEP. The value of TRUE means that the (half\ + \ MIP/sink part of the) ODU MIP receives the same signal direction as the\ + \ sink part of the ODU CEP. The Source part behaves similarly. This attribute\ + \ is meaningful only on objects instantiated under ODU CEP, and at least\ + \ one among ODU CEP and the subordinate object is bidirectional." + default: false tcm-field: type: "integer" format: "int32" @@ -20584,9 +20486,9 @@ definitions: accepted-payload-type: description: "This attribute is applicable when the ODU CTP object instance\ \ represents a lower order ODU CTP Sink at the client layer of the ODUP/ODU[i]j\ - \ or ODUP/ODUj-21 adaptation function. \r\n This attribute\ + \ or ODUP/ODUj-21 adaptation function. \r\n This attribute\ \ is a 2-digit Hex code that indicates the new accepted payload type.\r\n\ - \ Valid values are defined in Table 15-8 of ITU-T Recommendation\ + \ Valid values are defined in Table 15-8 of ITU-T Recommendation\ \ G.709 with one additional value UN_INTERPRETABLE." $ref: "#/definitions/tapi.odu.OduPayloadType" opu-tributary-slot-size: @@ -20597,16 +20499,6 @@ definitions: type: "string" description: "This attribute configures the type of the client CTP of the\ \ server ODU TTP." - tapi.odu.OwnedNodeEdgePointAugmentation1: - type: "object" - properties: - odu-node-edge-point-spec: - description: "Augments the base LayerProtocol information in NodeEdgePoint\ - \ with ODU-specific information" - $ref: "#/definitions/tapi.odu.OduNodeEdgePointSpec" - x-augmentation: - prefix: "tapi-odu" - namespace: "urn:onf:otcc:yang:tapi-odu" tapi.odu.PercentageGranularity: type: "string" enum: @@ -20614,6 +20506,29 @@ definitions: - "ONE_TENTHS" - "ONE_HUNDREDTHS" - "ONE_THOUSANDTHS" + tapi.odu.TcmExtension: + type: "string" + enum: + - "NORMAL" + - "PASS-THROUGH" + - "ERASE" + tapi.odu.TcmMode: + type: "string" + enum: + - "OPERATIONAL" + - "TRANSPARENT" + - "MONITOR" + tapi.odu.TcmStatus: + type: "string" + enum: + - "NO_SOURCE_TC" + - "IN_USE_WITHOUT_IAE" + - "IN_USE_WITH_IAE" + - "RESERVED_1" + - "RESERVED_2" + - "LCK" + - "OCI" + - "AIS" tapi.odu.TimDetMo: type: "string" enum: @@ -20645,7 +20560,7 @@ definitions: properties: output: $ref: "#/definitions/tapi.path.computation.computep2ppath.Output" - tapi.path.computation.ContextAugmentation3: + tapi.path.computation.ContextAugmentation2: type: "object" properties: path-computation-context: @@ -20714,8 +20629,10 @@ definitions: - type: "object" properties: topology-constraint: + type: "array" description: "none" - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" path: type: "array" description: "none" @@ -20729,12 +20646,18 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" routing-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.RoutingConstraint" optimization-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" + direction: + description: "none" + $ref: "#/definitions/tapi.common.ForwardingDirection" description: "none" tapi.path.computation.PathObjectiveFunction: allOf: @@ -20799,16 +20722,16 @@ definitions: description: "none" $ref: "#/definitions/tapi.common.Capacity" description: "The association of the FC to LTPs is made via EndPoints.\r\n \ - \ The EndPoint (EP) object class models the access to the FC\ - \ function. \r\n The traffic forwarding between the associated\ - \ EPs of the FC depends upon the type of FC and may be associated with FcSwitch\ - \ object instances. \r\n In cases where there is resilience\ - \ the EndPoint may convey the resilience role of the access to the FC. \r\n\ - \ It can represent a protected (resilient/reliable) point or\ - \ a protecting (unreliable working or protection) point.\r\n \ - \ The EP replaces the Protection Unit of a traditional protection model.\ - \ \r\n The ForwadingConstruct can be considered as a component\ - \ and the EndPoint as a Port on that component" + \ The EndPoint (EP) object class models the access to the FC function.\ + \ \r\n The traffic forwarding between the associated EPs of the\ + \ FC depends upon the type of FC and may be associated with FcSwitch object\ + \ instances. \r\n In cases where there is resilience the EndPoint\ + \ may convey the resilience role of the access to the FC. \r\n \ + \ It can represent a protected (resilient/reliable) point or a protecting\ + \ (unreliable working or protection) point.\r\n The EP replaces\ + \ the Protection Unit of a traditional protection model. \r\n The\ + \ ForwadingConstruct can be considered as a component and the EndPoint as\ + \ a Port on that component" tapi.path.computation.RouteObjectiveFunction: type: "string" enum: @@ -20826,6 +20749,9 @@ definitions: type: "boolean" description: "To distinguish if the resources are to be exclusive to the service" default: true + tolerable-impact: + type: "string" + description: "Grades of maximum tolerable disruption to traffic." diversity-policy: description: "none" $ref: "#/definitions/tapi.path.computation.DiversityPolicy" @@ -20849,78 +20775,100 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.topology.RiskCharacteristic" - route-direction: - description: "none" - $ref: "#/definitions/tapi.common.ForwardingDirection" tapi.path.computation.TopologyConstraint: - type: "object" - properties: - include-node: - type: "array" - description: "This is a loose constraint - that is it is unordered and could\ - \ be a partial list" - items: - $ref: "#/definitions/tapi.topology.NodeRef" - exclude-link: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.LinkRef" - avoid-topology: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.TopologyRef" - exclude-path: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.path.computation.PathRef" - include-link: - type: "array" - description: "This is a loose constraint - that is it is unordered and could\ - \ be a partial list " - items: - $ref: "#/definitions/tapi.topology.LinkRef" - preferred-transport-layer: - type: "array" - description: "soft constraint requested by client to indicate the layer(s)\ - \ of transport connection that it prefers to carry the service. This could\ - \ be same as the service layer or one of the supported server layers" - items: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + include-node: + type: "string" + description: "This is a loose constraint - that is it is unordered and could\ + \ be a partial list" + exclude-link: + type: "string" + description: "none" + avoid-topology: + type: "string" + description: "none" + exclude-path: + type: "string" + description: "none" + include-topology: + type: "string" + description: "none" + include-path: + type: "string" + description: "none" + exclude-node-edge-point: + type: "string" + description: "none" + include-node-edge-point: + type: "string" + description: "none" + include-link: + type: "string" + description: "This is a loose constraint - that is it is unordered and could\ + \ be a partial list " + preferred-transport-layer: + description: "soft constraint requested by client to indicate the layer(s)\ + \ of transport connection that it prefers to carry the service. This could\ + \ be same as the service layer or one of the supported server layers" $ref: "#/definitions/tapi.common.LayerProtocolName" - exclude-node: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.NodeRef" - include-topology: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.TopologyRef" - include-path: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.path.computation.PathRef" + exclude-node: + type: "string" + description: "none" + constraint-weight: + type: "integer" + format: "int32" + description: "Zero and positive values: zero means 'strongly required to\ + \ be included', +1 means 'less strongly required to be included', etc.\r\ + \n For example the work/intended route will be calculated\ + \ considering the topologies which weights are lowest (but not negative).\r\ + \n Negative values: -1 means 'strongly required to be excluded',\ + \ -2 means 'less strongly required to be excluded', etc." + description: "The TopologyConstraint allows to specify topology entities in\ + \ order to impose specific constraints (as denoted by the attribute name)\ + \ on Connectivity/Path.\r\n The topology entities are specified\ + \ by their instance uuid rather than using references/path (to allow for mapping\ + \ to Yang 1.0).\r\n This loose typing and reference necessitates\ + \ that implementations validate not only the presence of the instance, but\ + \ also that it is of the correct type as implied by the attribute name.\r\n\ + \ If this validation fails, then the implementation is expceted\ + \ to return an error.\r\n " tapi.path.computation.computep2ppath.Input: type: "object" properties: topology-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - routing-constraint: + end-point: + type: "array" description: "none" - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + items: + $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" objective-function: description: "none" $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" - sep: + name: type: "array" - description: "none" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." items: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + $ref: "#/definitions/tapi.common.NameAndValue" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.path.computation.computep2ppath.Output: type: "object" properties: @@ -20930,9 +20878,16 @@ definitions: tapi.path.computation.deletep2ppath.Input: type: "object" properties: - path-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.path.computation.deletep2ppath.Output: type: "object" properties: @@ -20942,15 +20897,29 @@ definitions: tapi.path.computation.optimizep2ppath.Input: type: "object" properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" routing-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - path-id-or-name: - type: "string" - description: "none" optimization-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" objective-function: description: "none" $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" @@ -21000,6 +20969,24 @@ definitions: frequency-constraint: description: "none" $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" + tapi.photonic.media.CentralFrequencyBand: + type: "object" + properties: + upper-central-frequency: + type: "integer" + format: "int32" + description: "The upper central frequency that can be tuned in the laser specified\ + \ in MHz.\r\n It is the oscillation frequency of the corresponding\ + \ electromagnetic wave. " + lower-central-frequency: + type: "integer" + format: "int32" + description: "The lower central frequency that can be tuned in the laser specified\ + \ in MHz.\r\n It is the oscillation frequency of the corresponding\ + \ electromagnetic wave. " + frequency-constraint: + description: "none" + $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" tapi.photonic.media.ConnectionEndPointAugmentation1: type: "object" properties: @@ -21019,34 +21006,6 @@ definitions: prefix: "tapi-photonic-media" namespace: "urn:onf:otcc:yang:tapi-photonic-media" tapi.photonic.media.ConnectionEndPointAugmentation3: - type: "object" - properties: - otsi-assembly-connection-end-point-spec: - description: "none" - $ref: "#/definitions/tapi.photonic.media.OtsiAssemblyConnectionEndPointSpec" - x-augmentation: - prefix: "tapi-photonic-media" - namespace: "urn:onf:otcc:yang:tapi-photonic-media" - tapi.photonic.media.ConnectionEndPointAugmentation4: - type: "object" - properties: - ots-connection-end-point-spec: - description: "none" - $ref: "#/definitions/tapi.photonic.media.OtsConnectionEndPointSpec" - x-augmentation: - prefix: "tapi-photonic-media" - namespace: "urn:onf:otcc:yang:tapi-photonic-media" - tapi.photonic.media.ConnectionEndPointAugmentation5: - type: "object" - properties: - otsi-connection-end-point-spec: - description: "Augments the base LayerProtocol information in ConnectionEndPoint\ - \ with OCH-specific information" - $ref: "#/definitions/tapi.photonic.media.OtsiConnectionEndPointSpec" - x-augmentation: - prefix: "tapi-photonic-media" - namespace: "urn:onf:otcc:yang:tapi-photonic-media" - tapi.photonic.media.ConnectionEndPointAugmentation6: type: "object" properties: media-channel-connection-end-point-spec: @@ -21055,34 +21014,25 @@ definitions: x-augmentation: prefix: "tapi-photonic-media" namespace: "urn:onf:otcc:yang:tapi-photonic-media" - tapi.photonic.media.ConnectionEndPointAugmentation7: - type: "object" - properties: - media-channel-assembly-spec: - description: "none" - $ref: "#/definitions/tapi.photonic.media.MediaChannelAssemblySpec" - x-augmentation: - prefix: "tapi-photonic-media" - namespace: "urn:onf:otcc:yang:tapi-photonic-media" tapi.photonic.media.EndPointAugmentation1: type: "object" properties: - media-channel-service-interface-point-spec: + otsi-connectivity-service-end-point-spec: description: "none" - $ref: "#/definitions/tapi.photonic.media.MediaChannelServiceInterfacePointSpec" + $ref: "#/definitions/tapi.photonic.media.OtsiConnectivityServiceEndPointSpec" x-augmentation: prefix: "tapi-photonic-media" namespace: "urn:onf:otcc:yang:tapi-photonic-media" tapi.photonic.media.EndPointAugmentation2: type: "object" properties: - otsi-connectivity-service-end-point-spec: + media-channel-connectivity-service-end-point-spec: description: "none" - $ref: "#/definitions/tapi.photonic.media.OtsiConnectivityServiceEndPointSpec" + $ref: "#/definitions/tapi.photonic.media.MediaChannelConnectivityServiceEndPointSpec" x-augmentation: prefix: "tapi-photonic-media" namespace: "urn:onf:otcc:yang:tapi-photonic-media" - tapi.photonic.media.FecPropertiesPac: + tapi.photonic.media.FecProperties: type: "object" properties: uncorrectable-bytes: @@ -21142,7 +21092,7 @@ definitions: - "FORCED-OFF" - "AUTOMATIC-LASER-SHUTDOWN" - "UNDEFINED" - tapi.photonic.media.LaserPropertiesPac: + tapi.photonic.media.LaserProperties: type: "object" properties: laser-application-type: @@ -21165,14 +21115,31 @@ definitions: - "PUMP" - "MODULATED" - "PULSE" - tapi.photonic.media.MediaChannelAssemblySpec: + tapi.photonic.media.MediaChannelConfigPac: type: "object" + properties: + spectrum: + description: "none" + $ref: "#/definitions/tapi.photonic.media.SpectrumBand" tapi.photonic.media.MediaChannelConnectionEndPointSpec: type: "object" properties: media-channel: description: "none" $ref: "#/definitions/tapi.photonic.media.MediaChannelPropertiesPac" + tapi.photonic.media.MediaChannelConnectivityServiceEndPointSpec: + type: "object" + properties: + power-management-config: + description: "This parameters shall be used to configure the expected\r\n\ + \ and intended (desired) power levels at the endpoints of\ + \ the media\r\n Channel connectivity service. These parameters\ + \ are dependent of the\r\n related OTSi power-management\ + \ capabilities exposed at the SIPs" + $ref: "#/definitions/tapi.photonic.media.PowerManagementConfigPac" + mc-config: + description: "none" + $ref: "#/definitions/tapi.photonic.media.MediaChannelConfigPac" tapi.photonic.media.MediaChannelNodeEdgePointSpec: type: "object" properties: @@ -21205,16 +21172,19 @@ definitions: $ref: "#/definitions/tapi.photonic.media.SpectrumBand" measured-power-egress: description: "none" - $ref: "#/definitions/tapi.photonic.media.PowerPropertiesPac" + $ref: "#/definitions/tapi.photonic.media.PowerProperties" measured-power-ingress: description: "none" - $ref: "#/definitions/tapi.photonic.media.PowerPropertiesPac" + $ref: "#/definitions/tapi.photonic.media.PowerProperties" tapi.photonic.media.MediaChannelServiceInterfacePointSpec: type: "object" properties: mc-pool: description: "none" $ref: "#/definitions/tapi.photonic.media.MediaChannelPoolCapabilityPac" + power-management-capability: + description: "none" + $ref: "#/definitions/tapi.photonic.media.PowerManagementCapabilityPac" tapi.photonic.media.ModulationTechnique: type: "string" enum: @@ -21237,29 +21207,25 @@ definitions: x-augmentation: prefix: "tapi-photonic-media" namespace: "urn:onf:otcc:yang:tapi-photonic-media" - tapi.photonic.media.OtsConnectionEndPointSpec: + tapi.photonic.media.NodeEdgePointAugmentation2: type: "object" properties: - ots-media-channel: - description: "none" - $ref: "#/definitions/tapi.photonic.media.MediaChannelPropertiesPac" + media-channel-node-edge-point-spec: + description: "Augments the base LayerProtocol information in NodeEdgePoint\ + \ with OCH-specific information" + $ref: "#/definitions/tapi.photonic.media.MediaChannelNodeEdgePointSpec" + x-augmentation: + prefix: "tapi-photonic-media" + namespace: "urn:onf:otcc:yang:tapi-photonic-media" tapi.photonic.media.OtsiAssemblyConnectionEndPointSpec: type: "object" properties: otsi-adapter: description: "none" - $ref: "#/definitions/tapi.photonic.media.OtsiGserverAdaptationPac" - fec-parameters: - description: "none" - $ref: "#/definitions/tapi.photonic.media.FecPropertiesPac" + $ref: "#/definitions/tapi.photonic.media.OtsiServerAdaptationPac" tapi.photonic.media.OtsiCapabilityPac: type: "object" properties: - supportable-lower-central-frequency: - type: "array" - description: "The lower frequency of the channel spectrum" - items: - $ref: "#/definitions/tapi.photonic.media.CentralFrequency" supportable-application-identifier: type: "array" description: "The list of supportable ApplicationIdentifiers." @@ -21273,11 +21239,16 @@ definitions: total-power-warn-threshold: description: "none" $ref: "#/definitions/tapi.photonic.media.TotalPowerThresholdPac" - supportable-upper-central-frequency: + supportable-central-frequency-band: type: "array" - description: "The Upper frequency of the channel spectrum" + description: "Each spectrum band supported for otsi trasmitter to be tuned\ + \ on, is specified\r\n as per it's lower and upper central\ + \ frequencies supported and its frequency constraints,\r\n \ + \ consisting in the frequency Grid and the AdjustmentGranularity, used\ + \ to uniquely identify all\r\n central frequencies supported\ + \ within the band." items: - $ref: "#/definitions/tapi.photonic.media.CentralFrequency" + $ref: "#/definitions/tapi.photonic.media.CentralFrequencyBand" tapi.photonic.media.OtsiConnectionEndPointSpec: type: "object" properties: @@ -21290,9 +21261,12 @@ definitions: otsi-config: description: "none" $ref: "#/definitions/tapi.photonic.media.OtsiTerminationConfigPac" - tapi.photonic.media.OtsiGserverAdaptationPac: + tapi.photonic.media.OtsiServerAdaptationPac: type: "object" properties: + fec-parameters: + description: "none" + $ref: "#/definitions/tapi.photonic.media.FecProperties" number-of-otsi: type: "integer" format: "int32" @@ -21303,6 +21277,9 @@ definitions: otsi-capability: description: "none" $ref: "#/definitions/tapi.photonic.media.OtsiCapabilityPac" + power-management-capability: + description: "none" + $ref: "#/definitions/tapi.photonic.media.PowerManagementCapabilityPac" tapi.photonic.media.OtsiTerminationConfigPac: type: "object" properties: @@ -21334,7 +21311,7 @@ definitions: \ as OTSi SIP capability." transmit-power: description: "Transmit power as requested." - $ref: "#/definitions/tapi.photonic.media.PowerPropertiesPac" + $ref: "#/definitions/tapi.photonic.media.PowerProperties" tapi.photonic.media.OtsiTerminationPac: type: "object" properties: @@ -21359,33 +21336,69 @@ definitions: $ref: "#/definitions/tapi.photonic.media.ApplicationIdentifier" received-power: description: "none" - $ref: "#/definitions/tapi.photonic.media.PowerPropertiesPac" + $ref: "#/definitions/tapi.photonic.media.PowerProperties" selected-central-frequency: description: "none" $ref: "#/definitions/tapi.photonic.media.CentralFrequency" transmited-power: description: "Measured power at the Transmitter." - $ref: "#/definitions/tapi.photonic.media.PowerPropertiesPac" + $ref: "#/definitions/tapi.photonic.media.PowerProperties" selected-modulation: description: "This parameter defines the modulation used at the source" $ref: "#/definitions/tapi.photonic.media.SelectedModulation" laser-properties: description: "Laser properties." - $ref: "#/definitions/tapi.photonic.media.LaserPropertiesPac" + $ref: "#/definitions/tapi.photonic.media.LaserProperties" selected-spectrum: description: "none" $ref: "#/definitions/tapi.photonic.media.SpectrumBand" - tapi.photonic.media.OwnedNodeEdgePointAugmentation2: + tapi.photonic.media.PowerManagementCapabilityPac: type: "object" properties: - media-channel-node-edge-point-spec: - description: "Augments the base LayerProtocol information in NodeEdgePoint\ - \ with OCH-specific information" - $ref: "#/definitions/tapi.photonic.media.MediaChannelNodeEdgePointSpec" - x-augmentation: - prefix: "tapi-photonic-media" - namespace: "urn:onf:otcc:yang:tapi-photonic-media" - tapi.photonic.media.PowerPropertiesPac: + tolerable-maximum-input-power: + description: "This parameter exposes the maximum input power tolerated\r\n\ + \ at the Logical-Termination-Point (LTP) associated to the\ + \ SIP." + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + supportable-minimum-output-power: + description: "This parameter exposes the minimum output power supported\r\n\ + \ at the Logical-Termination-Point (LTP) associated to the\ + \ SIP." + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + tolerable-minimum-input-power: + description: "This parameter exposes the minimum input power tolerated\r\n\ + \ at the Logical-Termination-Point (LTP) associated to the\ + \ SIP." + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + supportable-maximum-output-power: + description: "This parameter exposes the maximum output power supported\r\n\ + \ at the Logical-Termination-Point (LTP) associated to the\ + \ SIP." + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + tapi.photonic.media.PowerManagementConfigPac: + type: "object" + properties: + expected-maximum-input-power: + description: "This parameter shall be used to specify the maximum input power\r\ + \n being received at the Logical-Termination-Point (LTP)\ + \ associated to the CSEP." + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + expected-minimum-input-power: + description: "This parameter shall be used to specify the minimum input power\r\ + \n being received at the Logical-Termination-Point (LTP)\ + \ associated to the CSEP." + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + intended-minimum-output-power: + description: "This parameter shall be used to specify the minimum output power\r\ + \n desired at the Logical-Termination-Point (LTP) associated\ + \ to the CSEP." + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + intended-maximum-output-power: + description: "This parameter shall be used to specify the maximum output power\r\ + \n desired at the Logical-Termination-Point (LTP) associated\ + \ to the CSEP." + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + tapi.photonic.media.PowerProperties: type: "object" properties: power-spectral-density: @@ -21411,18 +21424,18 @@ definitions: tapi.photonic.media.ServiceInterfacePointAugmentation1: type: "object" properties: - media-channel-service-interface-point-spec: + otsi-service-interface-point-spec: description: "none" - $ref: "#/definitions/tapi.photonic.media.MediaChannelServiceInterfacePointSpec" + $ref: "#/definitions/tapi.photonic.media.OtsiServiceInterfacePointSpec" x-augmentation: prefix: "tapi-photonic-media" namespace: "urn:onf:otcc:yang:tapi-photonic-media" tapi.photonic.media.ServiceInterfacePointAugmentation2: type: "object" properties: - otsi-service-interface-point-spec: + media-channel-service-interface-point-spec: description: "none" - $ref: "#/definitions/tapi.photonic.media.OtsiServiceInterfacePointSpec" + $ref: "#/definitions/tapi.photonic.media.MediaChannelServiceInterfacePointSpec" x-augmentation: prefix: "tapi-photonic-media" namespace: "urn:onf:otcc:yang:tapi-photonic-media" @@ -21567,7 +21580,7 @@ definitions: type: "string" description: "High frequency deviation from true periodicity of a signal and\ \ therefore a small high rate of change of transfer latency.\r\n \ - \ Applies to TDM systems (and not packet)." + \ Applies to TDM systems (and not packet)." fixed-latency-characteristic: type: "string" description: "A TopologicalEntity suffers delay caused by the realization\ @@ -21578,7 +21591,7 @@ definitions: type: "string" description: "Low frequency deviation from true periodicity of a signal and\ \ therefore a small low rate of change of transfer latency.\r\n \ - \ Applies to TDM systems (and not packet)." + \ Applies to TDM systems (and not packet)." queing-latency-characteristic: type: "string" description: "The specific queuing latency for the traffic property." @@ -21610,19 +21623,22 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.common.LayerProtocolName" - resilience-type: + restoration-policy: description: "none" - $ref: "#/definitions/tapi.topology.ResilienceType" + $ref: "#/definitions/tapi.topology.RestorationPolicy" node-edge-point: type: "array" description: "none" items: $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + protection-type: + description: "none" + $ref: "#/definitions/tapi.topology.ProtectionType" direction: - description: "The directionality of the Link. \r\n Is\ - \ applicable to simple Links where all LinkEnds are BIDIRECTIONAL (the\ - \ Link will be BIDIRECTIONAL) or UNIDIRECTIONAL (the Link will be UNIDIRECTIONAL).\ - \ \r\n Is not present in more complex cases." + description: "The directionality of the Link. \r\n Is applicable\ + \ to simple Links where all LinkEnds are BIDIRECTIONAL (the Link will\ + \ be BIDIRECTIONAL) or UNIDIRECTIONAL (the Link will be UNIDIRECTIONAL).\ + \ \r\n Is not present in more complex cases." $ref: "#/definitions/tapi.common.ForwardingDirection" description: "The Link object class models effective adjacency between two or\ \ more ForwardingDomains (FD). " @@ -21636,6 +21652,16 @@ definitions: description: "none" x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:link/tapi-topology:uuid" description: "none" + tapi.topology.NepLayerProtocolCapability: + type: "object" + properties: + layer-protocol-qualifier: + type: "string" + description: "none" + number-of-cep-instances: + type: "integer" + format: "int32" + description: "none" tapi.topology.NetworkTopologyService: allOf: - $ref: "#/definitions/tapi.common.GlobalClass" @@ -21665,16 +21691,16 @@ definitions: encap-topology: description: "none" $ref: "#/definitions/tapi.topology.TopologyRef" - owned-node-edge-point: + node-rule-group: type: "array" description: "none" items: - $ref: "#/definitions/tapi.topology.NodeEdgePoint" - node-rule-group: + $ref: "#/definitions/tapi.topology.NodeRuleGroup" + node-edge-point: type: "array" description: "none" items: - $ref: "#/definitions/tapi.topology.NodeRuleGroup" + $ref: "#/definitions/tapi.topology.NodeEdgePoint" aggregated-node-edge-point: type: "array" description: "none" @@ -21683,8 +21709,8 @@ definitions: description: "The ForwardingDomain (FD) object class models the ForwardingDomain\ \ topological component which is used to effect forwarding of transport characteristic\ \ information and offers the potential to enable forwarding. \r\n \ - \ At the lowest level of recursion, an FD (within a network element\ - \ (NE)) represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ + \ At the lowest level of recursion, an FD (within a network element (NE))\ + \ represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ \ multiple switch matrices (FDs). " tapi.topology.NodeEdgePoint: allOf: @@ -21706,6 +21732,11 @@ definitions: \ balancing/Resilience) should be considered experimental" items: $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + available-cep-layer-protocol: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NepLayerProtocolCapability" aggregated-node-edge-point: type: "array" description: "none" @@ -21717,14 +21748,9 @@ definitions: link-port-direction: description: "The orientation of defined flow at the LinkEnd." $ref: "#/definitions/tapi.common.PortDirection" - supported-cep-layer-protocol-qualifier: - type: "array" - description: "none" - items: - type: "string" description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ \ termination and adaptation functions of one or more transport layers. \r\ - \n The structure of LTP supports all transport protocols including\ + \n The structure of LTP supports all transport protocols including\ \ circuit and packet forms." tapi.topology.NodeEdgePointRef: allOf: @@ -21734,7 +21760,7 @@ definitions: node-edge-point-uuid: type: "string" description: "none" - x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:owned-node-edge-point/tapi-topology:uuid" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:node-edge-point/tapi-topology:uuid" description: "none" tapi.topology.NodeRef: allOf: @@ -21789,41 +21815,32 @@ definitions: tapi.topology.ProtectionType: type: "string" enum: - - "NO_PROTECTON" + - "NO_PROTECTION" - "ONE_PLUS_ONE_PROTECTION" - - "ONE_PLUS_ONE_PROTECTION_WITH_DYNAMIC_RESTORATION" - - "PERMANENT_ONE_PLUS_ONE_PROTECTION" - "ONE_FOR_ONE_PROTECTION" - - "DYNAMIC_RESTORATION" - - "PRE_COMPUTED_RESTORATION" - tapi.topology.ResilienceType: - type: "object" - properties: - restoration-policy: - description: "none" - $ref: "#/definitions/tapi.topology.RestorationPolicy" - protection-type: - description: "none" - $ref: "#/definitions/tapi.topology.ProtectionType" + - "ONE_FOR_N_PROTECTION" + - "M_FOR_N_PROTECTION" + - "ONE_FOR_ONE_BY_N" tapi.topology.RestorationPolicy: type: "string" enum: - "PER_DOMAIN_RESTORATION" - "END_TO_END_RESTORATION" - "NA" + - "DYNAMIC_RESTORATION" + - "PRE_COMPUTED_RESTORATION" tapi.topology.RiskCharacteristic: type: "object" properties: risk-characteristic-name: type: "string" description: "The name of the risk characteristic. The characteristic may\ - \ be related to a specific degree of closeness. \r\n \ - \ For example a particular characteristic may apply to failures that are\ - \ localized (e.g. to one side of a road) where as another characteristic\ - \ may relate to failures that have a broader impact (e.g. both sides of\ - \ a road that crosses a bridge).\r\n Depending upon the\ - \ importance of the traffic being routed different risk characteristics\ - \ will be evaluated." + \ be related to a specific degree of closeness. \r\n For\ + \ example a particular characteristic may apply to failures that are localized\ + \ (e.g. to one side of a road) where as another characteristic may relate\ + \ to failures that have a broader impact (e.g. both sides of a road that\ + \ crosses a bridge).\r\n Depending upon the importance of\ + \ the traffic being routed different risk characteristics will be evaluated." risk-identifier-list: type: "array" description: "A list of the identifiers of each physical/geographic unit (with\ @@ -21885,11 +21902,16 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.topology.Node" + boundary-node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" description: "The ForwardingDomain (FD) object class models the ForwardingDomain\ \ topological component which is used to effect forwarding of transport characteristic\ \ information and offers the potential to enable forwarding. \r\n \ - \ At the lowest level of recursion, an FD (within a network element\ - \ (NE)) represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ + \ At the lowest level of recursion, an FD (within a network element (NE))\ + \ represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ \ multiple switch matrices (FDs). " tapi.topology.TopologyContext: type: "object" @@ -21924,7 +21946,7 @@ definitions: error-characteristic: type: "string" description: "Describes the degree to which the signal propagated can be errored.\ - \ \r\n Applies to TDM systems as the errored signal will\ + \ \r\n Applies to TDM systems as the errored signal will\ \ be propagated and not packet as errored packets will be discarded." unavailable-time-characteristic: type: "string" @@ -21937,19 +21959,19 @@ definitions: delivery-order-characteristic: type: "string" description: "Describes the degree to which packets will be delivered out\ - \ of sequence.\r\n Does not apply to TDM as the TDM protocols\ + \ of sequence.\r\n Does not apply to TDM as the TDM protocols\ \ maintain strict order." repeat-delivery-characteristic: type: "string" description: "Primarily applies to packet systems where a packet may be delivered\ - \ more than once (in fault recovery for example). \r\n \ - \ It can also apply to TDM where several frames may be received twice\ - \ due to switching in a system with a large differential propagation delay." + \ more than once (in fault recovery for example). \r\n It\ + \ can also apply to TDM where several frames may be received twice due to\ + \ switching in a system with a large differential propagation delay." loss-characteristic: type: "string" description: "Describes the acceptable characteristic of lost packets where\ \ loss may result from discard due to errors or overflow.\r\n \ - \ Applies to packet systems and not TDM (as for TDM errored signals\ + \ Applies to packet systems and not TDM (as for TDM errored signals\ \ are propagated unless grossly errored and overflow/underflow turns into\ \ timing slips)." tapi.topology.TransferTimingPac: @@ -21986,12 +22008,27 @@ definitions: tapi.topology.getlinkdetails.Input: type: "object" properties: - link-id-or-name: + link-id: type: "string" - description: "none" - topology-id-or-name: - type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.topology.getlinkdetails.Output: type: "object" properties: @@ -22001,12 +22038,27 @@ definitions: tapi.topology.getnodedetails.Input: type: "object" properties: - node-id-or-name: - type: "string" - description: "none" - topology-id-or-name: - type: "string" - description: "none" + node-id: + type: "string" + description: "UUID of the Node: An identifier that is universally unique within\ + \ an identifier space, where the identifier space is itself globally unique,\ + \ and immutable.\r\n An UUID carries no semantics with\ + \ respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC 4122. The canonical\ + \ representation uses lowercase characters.\r\n Pattern:\ + \ [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\ + \ \r\n Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.topology.getnodedetails.Output: type: "object" properties: @@ -22016,15 +22068,37 @@ definitions: tapi.topology.getnodeedgepointdetails.Input: type: "object" properties: - ep-id-or-name: - type: "string" - description: "none" - node-id-or-name: - type: "string" - description: "none" - topology-id-or-name: + node-id: + type: "string" + description: "UUID of the parent Node: An identifier that is universally unique\ + \ within an identifier space, where the identifier space is itself globally\ + \ unique, and immutable.\r\n An UUID carries no semantics\ + \ with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC 4122. The\ + \ canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\ + \ \r\n Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Node's Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + node-edge-point-id: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.topology.getnodeedgepointdetails.Output: type: "object" properties: @@ -22038,9 +22112,16 @@ definitions: tapi.topology.gettopologydetails.Input: type: "object" properties: - topology-id-or-name: + topology-id: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.topology.gettopologydetails.Output: type: "object" properties: @@ -22055,11 +22136,11 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.topology.Topology" - tapi.topology.node.OwnedNodeEdgePoint: + tapi.topology.node.NodeEdgePoint: allOf: - - $ref: "#/definitions/tapi.connectivity.OwnedNodeEdgePointAugmentation3" - - $ref: "#/definitions/tapi.odu.OwnedNodeEdgePointAugmentation1" - - $ref: "#/definitions/tapi.photonic.media.OwnedNodeEdgePointAugmentation2" + - $ref: "#/definitions/tapi.connectivity.NodeEdgePointAugmentation1" + - $ref: "#/definitions/tapi.odu.NodeEdgePointAugmentation3" + - $ref: "#/definitions/tapi.photonic.media.NodeEdgePointAugmentation2" - $ref: "#/definitions/tapi.topology.NodeEdgePoint" tapi.topology.topology.Node: allOf: @@ -22079,16 +22160,16 @@ definitions: encap-topology: description: "none" $ref: "#/definitions/tapi.topology.TopologyRef" - owned-node-edge-point: + node-rule-group: type: "array" description: "none" items: - $ref: "#/definitions/tapi.topology.node.OwnedNodeEdgePoint" - node-rule-group: + $ref: "#/definitions/tapi.topology.NodeRuleGroup" + node-edge-point: type: "array" description: "none" items: - $ref: "#/definitions/tapi.topology.NodeRuleGroup" + $ref: "#/definitions/tapi.topology.node.NodeEdgePoint" aggregated-node-edge-point: type: "array" description: "none" diff --git a/OAS/tapi-topology@2018-12-10.yaml b/OAS/tapi-topology@2019-03-31.yaml similarity index 61% rename from OAS/tapi-topology@2018-12-10.yaml rename to OAS/tapi-topology@2019-03-31.yaml index 83a270bb..e03e4938 100644 --- a/OAS/tapi-topology@2018-12-10.yaml +++ b/OAS/tapi-topology@2019-03-31.yaml @@ -1,9 +1,56 @@ --- swagger: "2.0" info: - description: "tapi-notification,tapi-topology,tapi-common API generated from yang\ - \ definitions" - version: "1.0" + description: "\r\n This module contains TAPI Notification Model definitions.\r\ + \n Source: TapiNotification.uml\r\n Copyright (c) 2018 Open Networking\ + \ Foundation (ONF). All rights reserved.\r\n License: This module is distributed\ + \ under the Apache License 2.0\r\n - The TAPI YANG models included in this\ + \ TAPI release are a *normative* part of the TAPI SDK.\r\n - The YANG specifications\ + \ have been generated from the corresponding UML model using the [ONF EAGLE UML2YANG\ + \ mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Topology\ + \ Model definitions.\r\n Source: TapiTopology.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Common Model\ + \ definitions.\r\n Source: TapiCommon.uml\r\n Copyright (c) 2018\ + \ Open Networking Foundation (ONF). All rights reserved.\r\n License: This\ + \ module is distributed under the Apache License 2.0\r\n - The TAPI YANG\ + \ models included in this TAPI release are a *normative* part of the TAPI SDK.\r\ + \n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases." + version: "2.2.0" title: "tapi-notification,tapi-topology,tapi-common API" host: "localhost:1234" consumes: @@ -15,7 +62,8 @@ paths: get: tags: - "tapi-common" - description: "returns tapi.common.Context" + summary: "returns tapi.common.Context" + description: "none" parameters: [] responses: 200: @@ -27,7 +75,8 @@ paths: post: tags: - "tapi-common" - description: "creates tapi.common.Context" + summary: "creates tapi.common.Context" + description: "none" parameters: - in: "body" name: "tapi.common.Context.body-param" @@ -45,7 +94,8 @@ paths: put: tags: - "tapi-common" - description: "creates or updates tapi.common.Context" + summary: "creates or updates tapi.common.Context" + description: "none" parameters: - in: "body" name: "tapi.common.Context.body-param" @@ -63,7 +113,8 @@ paths: delete: tags: - "tapi-common" - description: "removes tapi.common.Context" + summary: "removes tapi.common.Context" + description: "none" parameters: [] responses: 400: @@ -74,7 +125,10 @@ paths: post: tags: - "tapi-common" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - in: "body" name: "tapi.common.NameAndValue.body-param" @@ -93,7 +147,10 @@ paths: get: tags: - "tapi-common" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "value-name" in: "path" @@ -107,33 +164,13 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-common" - description: "creates or updates tapi.common.NameAndValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "value-name" in: "path" @@ -156,7 +193,10 @@ paths: delete: tags: - "tapi-common" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "value-name" in: "path" @@ -172,7 +212,8 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.notification.NotificationContext" + summary: "returns tapi.notification.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" parameters: [] responses: 200: @@ -184,7 +225,8 @@ paths: post: tags: - "tapi-notification" - description: "creates tapi.notification.NotificationContext" + summary: "creates tapi.notification.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" parameters: - in: "body" name: "tapi.notification.NotificationContext.body-param" @@ -202,7 +244,8 @@ paths: put: tags: - "tapi-notification" - description: "creates or updates tapi.notification.NotificationContext" + summary: "creates or updates tapi.notification.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" parameters: - in: "body" name: "tapi.notification.NotificationContext.body-param" @@ -220,7 +263,8 @@ paths: delete: tags: - "tapi-notification" - description: "removes tapi.notification.NotificationContext" + summary: "removes tapi.notification.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" parameters: [] responses: 400: @@ -231,7 +275,8 @@ paths: post: tags: - "tapi-notification" - description: "creates tapi.notification.NotificationSubscriptionService" + summary: "creates tapi.notification.NotificationSubscriptionService" + description: "none" parameters: - in: "body" name: "tapi.notification.NotificationSubscriptionService.body-param" @@ -251,7 +296,8 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.notification.NotificationSubscriptionService" + summary: "returns tapi.notification.NotificationSubscriptionService" + description: "none" parameters: - name: "uuid" in: "path" @@ -265,34 +311,11 @@ paths: $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" 400: description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationSubscriptionService" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationSubscriptionService.body-param" - description: "tapi.notification.NotificationSubscriptionService to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-notification" - description: "creates or updates tapi.notification.NotificationSubscriptionService" + summary: "creates or updates tapi.notification.NotificationSubscriptionService" + description: "none" parameters: - name: "uuid" in: "path" @@ -316,7 +339,8 @@ paths: delete: tags: - "tapi-notification" - description: "removes tapi.notification.NotificationSubscriptionService" + summary: "removes tapi.notification.NotificationSubscriptionService" + description: "none" parameters: - name: "uuid" in: "path" @@ -332,7 +356,10 @@ paths: post: tags: - "tapi-notification" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -356,7 +383,10 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -375,38 +405,13 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -434,7 +439,10 @@ paths: delete: tags: - "tapi-notification" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -455,7 +463,8 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.notification.NotificationChannel" + summary: "returns tapi.notification.NotificationChannel" + description: "none" parameters: - name: "uuid" in: "path" @@ -469,96 +478,14 @@ paths: $ref: "#/definitions/tapi.notification.NotificationChannel" 400: description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationChannel.body-param" - description: "tapi.notification.NotificationChannel to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationChannel.body-param" - description: "tapi.notification.NotificationChannel to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/notification-channel/name/: - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" /data/context/notification-context/notif-subscription={uuid}/notification-channel/name={value-name}/: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -577,87 +504,12 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/: get: tags: - "tapi-notification" - description: "returns tapi.notification.Notification" + summary: "returns tapi.notification.Notification" + description: "none" parameters: - name: "uuid" in: "path" @@ -680,7 +532,8 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -704,34 +557,12 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/alarm-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.AlarmInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.AlarmInfo" - schema: - $ref: "#/definitions/tapi.notification.AlarmInfo" - 400: - description: "Internal error" /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/changed-attributes={value-name}/: get: tags: - "tapi-notification" - description: "returns tapi.notification.NameAndValueChange" + summary: "returns tapi.notification.NameAndValueChange" + description: "none" parameters: - name: "uuid" in: "path" @@ -759,7 +590,10 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -787,7 +621,8 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -811,34 +646,12 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/tca-info/: + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/: get: tags: - "tapi-notification" - description: "returns tapi.notification.TcaInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.TcaInfo" - schema: - $ref: "#/definitions/tapi.notification.TcaInfo" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/subscription-filter/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.SubscriptionFilter" + summary: "returns tapi.notification.SubscriptionFilter" + description: "none" parameters: - name: "uuid" in: "path" @@ -855,7 +668,8 @@ paths: post: tags: - "tapi-notification" - description: "creates tapi.notification.SubscriptionFilter" + summary: "creates tapi.notification.SubscriptionFilter" + description: "none" parameters: - name: "uuid" in: "path" @@ -878,7 +692,8 @@ paths: put: tags: - "tapi-notification" - description: "creates or updates tapi.notification.SubscriptionFilter" + summary: "creates or updates tapi.notification.SubscriptionFilter" + description: "none" parameters: - name: "uuid" in: "path" @@ -901,7 +716,8 @@ paths: delete: tags: - "tapi-notification" - description: "removes tapi.notification.SubscriptionFilter" + summary: "removes tapi.notification.SubscriptionFilter" + description: "none" parameters: - name: "uuid" in: "path" @@ -917,7 +733,10 @@ paths: post: tags: - "tapi-notification" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -941,7 +760,10 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -960,38 +782,13 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -1019,7 +816,10 @@ paths: delete: tags: - "tapi-notification" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -1040,7 +840,8 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.notification.Notification" + summary: "returns tapi.notification.Notification" + description: "none" parameters: - name: "uuid" in: "path" @@ -1058,7 +859,8 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -1077,29 +879,12 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/notification-context/notification={uuid}/alarm-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.AlarmInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.AlarmInfo" - schema: - $ref: "#/definitions/tapi.notification.AlarmInfo" - 400: - description: "Internal error" /data/context/notification-context/notification={uuid}/changed-attributes={value-name}/: get: tags: - "tapi-notification" - description: "returns tapi.notification.NameAndValueChange" + summary: "returns tapi.notification.NameAndValueChange" + description: "none" parameters: - name: "uuid" in: "path" @@ -1122,7 +907,10 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -1145,7 +933,8 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -1164,29 +953,12 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/notification-context/notification={uuid}/tca-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.TcaInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.TcaInfo" - schema: - $ref: "#/definitions/tapi.notification.TcaInfo" - 400: - description: "Internal error" /data/context/service-interface-point/: post: tags: - "tapi-common" - description: "creates tapi.common.ServiceInterfacePoint" + summary: "creates tapi.common.ServiceInterfacePoint" + description: "none" parameters: - in: "body" name: "tapi.common.ServiceInterfacePoint.body-param" @@ -1205,7 +977,8 @@ paths: get: tags: - "tapi-common" - description: "returns tapi.common.ServiceInterfacePoint" + summary: "returns tapi.common.ServiceInterfacePoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -1219,33 +992,11 @@ paths: $ref: "#/definitions/tapi.common.ServiceInterfacePoint" 400: description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.ServiceInterfacePoint.body-param" - description: "tapi.common.ServiceInterfacePoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-common" - description: "creates or updates tapi.common.ServiceInterfacePoint" + summary: "creates or updates tapi.common.ServiceInterfacePoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -1268,7 +1019,8 @@ paths: delete: tags: - "tapi-common" - description: "removes tapi.common.ServiceInterfacePoint" + summary: "removes tapi.common.ServiceInterfacePoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -1284,7 +1036,8 @@ paths: get: tags: - "tapi-common" - description: "returns tapi.common.Capacity" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" @@ -1298,101 +1051,13 @@ paths: $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/committed-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" /data/context/service-interface-point={uuid}/available-capacity/total-size/: get: tags: - "tapi-common" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -1410,7 +1075,10 @@ paths: post: tags: - "tapi-common" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -1434,7 +1102,10 @@ paths: get: tags: - "tapi-common" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -1453,38 +1124,13 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-common" - description: "creates or updates tapi.common.NameAndValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -1512,7 +1158,10 @@ paths: delete: tags: - "tapi-common" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -1533,7 +1182,9 @@ paths: get: tags: - "tapi-common" - description: "returns tapi.common.Capacity" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" @@ -1547,11 +1198,13 @@ paths: $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/: + /data/context/service-interface-point={uuid}/total-potential-capacity/total-size/: get: tags: - "tapi-common" - description: "returns tapi.common.BandwidthProfile" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -1560,136 +1213,49 @@ paths: type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/: + /data/context/topology-context/: get: tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" + - "tapi-topology" + summary: "returns tapi.topology.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: [] responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.TopologyContext" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.TopologyContext" 400: description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/: - get: + post: tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" + - "tapi-topology" + summary: "creates tapi.topology.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" + - in: "body" + name: "tapi.topology.TopologyContext.body-param" + description: "tapi.topology.TopologyContext to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.topology.TopologyContext" responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: + 409: + description: "Object already exists" + put: tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/total-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.TopologyContext" - parameters: [] - responses: - 200: - description: "tapi.topology.TopologyContext" - schema: - $ref: "#/definitions/tapi.topology.TopologyContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-topology" - description: "creates tapi.topology.TopologyContext" - parameters: - - in: "body" - name: "tapi.topology.TopologyContext.body-param" - description: "tapi.topology.TopologyContext to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.TopologyContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-topology" - description: "creates or updates tapi.topology.TopologyContext" + - "tapi-topology" + summary: "creates or updates tapi.topology.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" parameters: - in: "body" name: "tapi.topology.TopologyContext.body-param" @@ -1707,7 +1273,8 @@ paths: delete: tags: - "tapi-topology" - description: "removes tapi.topology.TopologyContext" + summary: "removes tapi.topology.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" parameters: [] responses: 400: @@ -1718,7 +1285,8 @@ paths: get: tags: - "tapi-topology" - description: "returns tapi.topology.NetworkTopologyService" + summary: "returns tapi.topology.NetworkTopologyService" + description: "none" parameters: [] responses: 200: @@ -1731,7 +1299,10 @@ paths: get: tags: - "tapi-topology" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "value-name" in: "path" @@ -1749,7 +1320,8 @@ paths: get: tags: - "tapi-topology" - description: "returns tapi.topology.TopologyRef" + summary: "returns tapi.topology.TopologyRef" + description: "none" parameters: - name: "topology-uuid" in: "path" @@ -1767,7 +1339,8 @@ paths: get: tags: - "tapi-topology" - description: "returns tapi.topology.Topology" + summary: "returns tapi.topology.Topology" + description: "none" parameters: - name: "uuid" in: "path" @@ -1781,126 +1354,46 @@ paths: $ref: "#/definitions/tapi.topology.Topology" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Link" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Link" - schema: - $ref: "#/definitions/tapi.topology.Link" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/committed-burst-size/: + /data/context/topology-context/topology={uuid}/boundary-node-edge-point={topology-uuid},{node-uuid},{node-edge-point-uuid}/: get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "link-uuid" + - name: "topology-uuid" in: "path" - description: "Id of link" + description: "Id of boundary-node-edge-point" required: true type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" + - name: "node-uuid" in: "path" - description: "Id of topology" + description: "Id of boundary-node-edge-point" required: true type: "string" - - name: "link-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of link" + description: "Id of boundary-node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.NodeEdgePointRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/peak-burst-size/: + /data/context/topology-context/topology={uuid}/link={link-uuid}/: get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.Link" + description: "none" parameters: - name: "uuid" in: "path" @@ -1914,16 +1407,17 @@ paths: type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.Link" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.Link" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/peak-information-rate/: + /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/: get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" @@ -1937,16 +1431,18 @@ paths: type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/total-size/: get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -1969,7 +1465,9 @@ paths: get: tags: - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" @@ -1997,7 +1495,9 @@ paths: get: tags: - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" @@ -2025,7 +1525,10 @@ paths: get: tags: - "tapi-topology" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -2053,7 +1556,8 @@ paths: : get: tags: - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -2087,34 +1591,13 @@ paths: $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/resilience-type/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.ResilienceType" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.ResilienceType" - schema: - $ref: "#/definitions/tapi.topology.ResilienceType" - 400: - description: "Internal error" /data/context/topology-context/topology={uuid}/link={link-uuid}/risk-characteristic={risk-characteristic-name}/: get: tags: - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." parameters: - name: "uuid" in: "path" @@ -2142,7 +1625,9 @@ paths: get: tags: - "tapi-topology" - description: "returns tapi.common.Capacity" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" @@ -2161,11 +1646,13 @@ paths: $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/: + /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/total-size/: get: tags: - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -2179,16 +1666,18 @@ paths: type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: + /data/context/topology-context/topology={uuid}/link={link-uuid}/validation-mechanism={validation-mechanism}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.ValidationMechanism" + description: "Provides details of the specific validation mechanism(s) used\ + \ to confirm the presence of an intended topologicalEntity." parameters: - name: "uuid" in: "path" @@ -2200,161 +1689,163 @@ paths: description: "Id of link" required: true type: "string" + - name: "validation-mechanism" + in: "path" + description: "Id of validation-mechanism" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.ValidationMechanism" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.ValidationMechanism" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: + /data/context/topology-context/topology={uuid}/name={value-name}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "link-uuid" + - name: "value-name" in: "path" - description: "Id of link" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: + /data/context/topology-context/topology={uuid}/node={node-uuid}/: get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.Node" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "link-uuid" + - name: "node-uuid" in: "path" - description: "Id of link" + description: "Id of node" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.Node" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.Node" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "link-uuid" + - name: "node-uuid" in: "path" - description: "Id of link" + description: "Id of node" required: true type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" + - name: "topology-uuid" in: "path" - description: "Id of topology" + description: "Id of aggregated-node-edge-point" required: true type: "string" - - name: "link-uuid" + - name: "aggregated-node-edge-point-node-uuid" in: "path" - description: "Id of link" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.NodeEdgePointRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/validation-mechanism={validation-mechanism}/: + /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/: get: tags: - "tapi-topology" - description: "returns tapi.topology.ValidationMechanism" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "validation-mechanism" + - name: "node-uuid" in: "path" - description: "Id of validation-mechanism" + description: "Id of node" required: true type: "string" responses: 200: - description: "tapi.topology.ValidationMechanism" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.topology.ValidationMechanism" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/name={value-name}/: + /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/total-size/: get: tags: - "tapi-topology" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "value-name" + - name: "node-uuid" in: "path" - description: "Id of name" + description: "Id of node" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/: + /data/context/topology-context/topology={uuid}/node={node-uuid}/cost-characteristic={cost-name}/: get: tags: - "tapi-topology" - description: "returns tapi.topology.Node" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" @@ -2366,18 +1857,24 @@ paths: description: "Id of node" required: true type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" responses: 200: - description: "tapi.topology.Node" + description: "tapi.topology.CostCharacteristic" schema: - $ref: "#/definitions/tapi.topology.Node" + $ref: "#/definitions/tapi.topology.CostCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/encap-topology/: + get: tags: - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" + summary: "returns tapi.topology.TopologyRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -2389,33 +1886,20 @@ paths: description: "Id of node" required: true type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "aggregated-node-edge-point-node-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" responses: 200: - description: "tapi.topology.NodeEdgePointRef" + description: "tapi.topology.TopologyRef" schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + $ref: "#/definitions/tapi.topology.TopologyRef" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/: + /data/context/topology-context/topology={uuid}/node={node-uuid}/latency-characteristic={traffic-property-name}/: get: tags: - "tapi-topology" - description: "returns tapi.common.Capacity" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" @@ -2427,18 +1911,26 @@ paths: description: "Id of node" required: true type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" responses: 200: - description: "tapi.common.Capacity" + description: "tapi.topology.LatencyCharacteristic" schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/: + /data/context/topology-context/topology={uuid}/node={node-uuid}/name={value-name}/: get: tags: - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -2450,18 +1942,24 @@ paths: description: "Id of node" required: true type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/committed-burst-size/: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/: get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.NodeEdgePoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -2473,18 +1971,24 @@ paths: description: "Id of node" required: true type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.NodeEdgePoint" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.NodeEdgePoint" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{aggregated-node-edge-point-node-edge-point-uuid}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -2496,18 +2000,39 @@ paths: description: "Id of node" required: true type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "aggregated-node-edge-point-node-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "aggregated-node-edge-point-node-edge-point-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.NodeEdgePointRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/peak-burst-size/: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-capacity/: get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" @@ -2519,18 +2044,25 @@ paths: description: "Id of node" required: true type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/peak-information-rate/: - get: + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-capacity/total-size/ + : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -2542,6 +2074,11 @@ paths: description: "Id of node" required: true type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" responses: 200: description: "tapi.common.CapacityValue" @@ -2549,11 +2086,12 @@ paths: $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/total-size/: - get: + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-cep-layer-protocol={layer-protocol-qualifier}/ + : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.NepLayerProtocolCapability" + description: "none" parameters: - name: "uuid" in: "path" @@ -2565,18 +2103,31 @@ paths: description: "Id of node" required: true type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "layer-protocol-qualifier" + in: "path" + description: "Id of available-cep-layer-protocol" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.NepLayerProtocolCapability" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.NepLayerProtocolCapability" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/cost-characteristic={cost-name}/: - get: + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/mapped-service-interface-point={service-interface-point-uuid}/ + : get: tags: - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "NodeEdgePoint mapped to more than ServiceInterfacePoint (slicing/virtualizing)\ + \ or a ServiceInterfacePoint mapped to more than one NodeEdgePoint (load balancing/Resilience)\ + \ should be considered experimental" parameters: - name: "uuid" in: "path" @@ -2588,23 +2139,31 @@ paths: description: "Id of node" required: true type: "string" - - name: "cost-name" + - name: "node-edge-point-uuid" in: "path" - description: "Id of cost-characteristic" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "service-interface-point-uuid" + in: "path" + description: "Id of mapped-service-interface-point" required: true type: "string" responses: 200: - description: "tapi.topology.CostCharacteristic" + description: "tapi.common.ServiceInterfacePointRef" schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/encap-topology/: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/name={value-name}/: get: tags: - "tapi-topology" - description: "returns tapi.topology.TopologyRef" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -2616,18 +2175,30 @@ paths: description: "Id of node" required: true type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" responses: 200: - description: "tapi.topology.TopologyRef" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.topology.TopologyRef" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/latency-characteristic={traffic-property-name}/: - get: + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/total-potential-capacity/ + : get: tags: - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" @@ -2639,23 +2210,25 @@ paths: description: "Id of node" required: true type: "string" - - name: "traffic-property-name" + - name: "node-edge-point-uuid" in: "path" - description: "Id of latency-characteristic" + description: "Id of node-edge-point" required: true type: "string" responses: 200: - description: "tapi.topology.LatencyCharacteristic" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/name={value-name}/: - get: + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/total-potential-capacity/total-size/ + : get: tags: - "tapi-topology" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -2667,23 +2240,24 @@ paths: description: "Id of node" required: true type: "string" - - name: "value-name" + - name: "node-edge-point-uuid" in: "path" - description: "Id of name" + description: "Id of node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/: get: tags: - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroup" + summary: "returns tapi.topology.NodeRuleGroup" + description: "none" parameters: - name: "uuid" in: "path" @@ -2711,7 +2285,8 @@ paths: get: tags: - "tapi-topology" - description: "returns tapi.common.Capacity" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" @@ -2735,11 +2310,13 @@ paths: $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/total-size/ : get: tags: - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -2758,16 +2335,17 @@ paths: type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/composed-rule-group={topology-uuid},{composed-rule-group-node-uuid},{composed-rule-group-node-rule-group-uuid}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.NodeRuleGroupRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -2784,46 +2362,35 @@ paths: description: "Id of node-rule-group" required: true type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" + - name: "topology-uuid" in: "path" - description: "Id of topology" + description: "Id of composed-rule-group" required: true type: "string" - - name: "node-uuid" + - name: "composed-rule-group-node-uuid" in: "path" - description: "Id of node" + description: "Id of composed-rule-group" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "composed-rule-group-node-rule-group-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of composed-rule-group" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.NodeRuleGroupRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/cost-characteristic={cost-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" @@ -2840,18 +2407,24 @@ paths: description: "Id of node-rule-group" required: true type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.CostCharacteristic" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.CostCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.InterRuleGroup" + description: "none" parameters: - name: "uuid" in: "path" @@ -2868,46 +2441,24 @@ paths: description: "Id of node-rule-group" required: true type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of inter-rule-group" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.InterRuleGroup" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.InterRuleGroup" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/composed-rule-group={topology-uuid},{composed-rule-group-node-uuid},{composed-rule-group-node-rule-group-uuid}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/associated-node-rule-group={topology-uuid},{associated-node-rule-group-node-uuid},{associated-node-rule-group-node-rule-group-uuid}/ : get: tags: - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroupRef" + summary: "returns tapi.topology.NodeRuleGroupRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -2924,19 +2475,24 @@ paths: description: "Id of node-rule-group" required: true type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" - name: "topology-uuid" in: "path" - description: "Id of composed-rule-group" + description: "Id of associated-node-rule-group" required: true type: "string" - - name: "composed-rule-group-node-uuid" + - name: "associated-node-rule-group-node-uuid" in: "path" - description: "Id of composed-rule-group" + description: "Id of associated-node-rule-group" required: true type: "string" - - name: "composed-rule-group-node-rule-group-uuid" + - name: "associated-node-rule-group-node-rule-group-uuid" in: "path" - description: "Id of composed-rule-group" + description: "Id of associated-node-rule-group" required: true type: "string" responses: @@ -2946,11 +2502,12 @@ paths: $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/cost-characteristic={cost-name}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/ : get: tags: - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" @@ -2967,23 +2524,25 @@ paths: description: "Id of node-rule-group" required: true type: "string" - - name: "cost-name" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of cost-characteristic" + description: "Id of inter-rule-group" required: true type: "string" responses: 200: - description: "tapi.topology.CostCharacteristic" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/total-size/ : get: tags: - "tapi-topology" - description: "returns tapi.topology.InterRuleGroup" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -3007,16 +2566,18 @@ paths: type: "string" responses: 200: - description: "tapi.topology.InterRuleGroup" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.topology.InterRuleGroup" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/associated-node-rule-group={topology-uuid},{associated-node-rule-group-node-uuid},{associated-node-rule-group-node-rule-group-uuid}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/cost-characteristic={cost-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroupRef" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" @@ -3038,33 +2599,25 @@ paths: description: "Id of inter-rule-group" required: true type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of associated-node-rule-group" - required: true - type: "string" - - name: "associated-node-rule-group-node-uuid" - in: "path" - description: "Id of associated-node-rule-group" - required: true - type: "string" - - name: "associated-node-rule-group-node-rule-group-uuid" + - name: "cost-name" in: "path" - description: "Id of associated-node-rule-group" + description: "Id of cost-characteristic" required: true type: "string" responses: 200: - description: "tapi.topology.NodeRuleGroupRef" + description: "tapi.topology.CostCharacteristic" schema: - $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + $ref: "#/definitions/tapi.topology.CostCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/latency-characteristic={traffic-property-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.Capacity" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" @@ -3086,18 +2639,26 @@ paths: description: "Id of inter-rule-group" required: true type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" responses: 200: - description: "tapi.common.Capacity" + description: "tapi.topology.LatencyCharacteristic" schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/name={value-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -3119,18 +2680,25 @@ paths: description: "Id of inter-rule-group" required: true type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." parameters: - name: "uuid" in: "path" @@ -3152,18 +2720,24 @@ paths: description: "Id of inter-rule-group" required: true type: "string" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-characteristic" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.RiskCharacteristic" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.RiskCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.Rule" + description: "none" parameters: - name: "uuid" in: "path" @@ -3185,18 +2759,26 @@ paths: description: "Id of inter-rule-group" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.Rule" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.Rule" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/name={value-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -3218,51 +2800,30 @@ paths: description: "Id of inter-rule-group" required: true type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" + - name: "local-id" in: "path" - description: "Id of node-rule-group" + description: "Id of rule" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "value-name" in: "path" - description: "Id of inter-rule-group" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/total-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" @@ -3286,16 +2847,18 @@ paths: type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/cost-characteristic={cost-name}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/total-size/ : get: tags: - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -3317,23 +2880,20 @@ paths: description: "Id of inter-rule-group" required: true type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" responses: 200: - description: "tapi.topology.CostCharacteristic" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/latency-characteristic={traffic-property-name}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/latency-characteristic={traffic-property-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" @@ -3350,11 +2910,6 @@ paths: description: "Id of node-rule-group" required: true type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - name: "traffic-property-name" in: "path" description: "Id of latency-characteristic" @@ -3367,11 +2922,14 @@ paths: $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/name={value-name}/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/name={value-name}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -3388,11 +2946,6 @@ paths: description: "Id of node-rule-group" required: true type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - name: "value-name" in: "path" description: "Id of name" @@ -3405,11 +2958,12 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/node-edge-point={topology-uuid},{node-edge-point-node-uuid},{node-edge-point-uuid}/ : get: tags: - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -3426,66 +2980,35 @@ paths: description: "Id of node-rule-group" required: true type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Rule" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" + - name: "topology-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "node-edge-point-node-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "local-id" + - name: "node-edge-point-uuid" in: "path" - description: "Id of rule" + description: "Id of node-edge-point" required: true type: "string" responses: 200: - description: "tapi.topology.Rule" + description: "tapi.topology.NodeEdgePointRef" schema: - $ref: "#/definitions/tapi.topology.Rule" + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/name={value-name}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." parameters: - name: "uuid" in: "path" @@ -3502,1225 +3025,24 @@ paths: description: "Id of node-rule-group" required: true type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "local-id" + - name: "risk-characteristic-name" in: "path" - description: "Id of rule" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/latency-characteristic={traffic-property-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/node-edge-point={topology-uuid},{node-edge-point-node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-edge-point-node-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Rule" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of rule" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Rule" - schema: - $ref: "#/definitions/tapi.topology.Rule" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/name={value-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of rule" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePoint" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePoint" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "aggregated-node-edge-point-node-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/mapped-service-interface-point={service-interface-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.ServiceInterfacePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "service-interface-point-uuid" - in: "path" - description: "Id of mapped-service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.ServiceInterfacePointRef" - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/name={value-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" + description: "Id of risk-characteristic" required: true type: "string" responses: 200: - description: "tapi.common.Capacity" + description: "tapi.topology.RiskCharacteristic" schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.topology.RiskCharacteristic" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/: get: tags: - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" + summary: "returns tapi.topology.Rule" + description: "none" parameters: - name: "uuid" in: "path" @@ -4732,18 +3054,31 @@ paths: description: "Id of node" required: true type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.topology.Rule" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.topology.Rule" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/name={value-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -4755,18 +3090,35 @@ paths: description: "Id of node" required: true type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" @@ -4778,18 +3130,25 @@ paths: description: "Id of node" required: true type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/total-size/ + : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -4801,6 +3160,11 @@ paths: description: "Id of node" required: true type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" responses: 200: description: "tapi.common.CapacityValue" @@ -4808,11 +3172,13 @@ paths: $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" @@ -4826,16 +3192,18 @@ paths: type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/total-size/: get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -4858,6 +3226,8 @@ paths: post: tags: - "tapi-notification" + summary: "operates on tapi.notification.CreateNotificationSubscriptionService" + description: "operates on tapi.notification.CreateNotificationSubscriptionService" parameters: - in: "body" name: "tapi.notification.createnotificationsubscriptionservice.Input.body-param" @@ -4879,6 +3249,8 @@ paths: post: tags: - "tapi-notification" + summary: "operates on tapi.notification.DeleteNotificationSubscriptionService" + description: "operates on tapi.notification.DeleteNotificationSubscriptionService" parameters: - in: "body" name: "tapi.notification.deletenotificationsubscriptionservice.Input.body-param" @@ -4888,10 +3260,6 @@ paths: input: $ref: "#/definitions/tapi.notification.deletenotificationsubscriptionservice.Input" responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.DeleteNotificationSubscriptionService" 201: description: "No response" 400: @@ -4900,6 +3268,8 @@ paths: post: tags: - "tapi-topology" + summary: "operates on tapi.topology.GetLinkDetails" + description: "operates on tapi.topology.GetLinkDetails" parameters: - in: "body" name: "tapi.topology.getlinkdetails.Input.body-param" @@ -4921,6 +3291,8 @@ paths: post: tags: - "tapi-topology" + summary: "operates on tapi.topology.GetNodeDetails" + description: "operates on tapi.topology.GetNodeDetails" parameters: - in: "body" name: "tapi.topology.getnodedetails.Input.body-param" @@ -4942,6 +3314,8 @@ paths: post: tags: - "tapi-topology" + summary: "operates on tapi.topology.GetNodeEdgePointDetails" + description: "operates on tapi.topology.GetNodeEdgePointDetails" parameters: - in: "body" name: "tapi.topology.getnodeedgepointdetails.Input.body-param" @@ -4963,6 +3337,8 @@ paths: post: tags: - "tapi-notification" + summary: "operates on tapi.notification.GetNotificationList" + description: "operates on tapi.notification.GetNotificationList" parameters: - in: "body" name: "tapi.notification.getnotificationlist.Input.body-param" @@ -4984,6 +3360,8 @@ paths: post: tags: - "tapi-notification" + summary: "operates on tapi.notification.GetNotificationSubscriptionServiceDetails" + description: "operates on tapi.notification.GetNotificationSubscriptionServiceDetails" parameters: - in: "body" name: "tapi.notification.getnotificationsubscriptionservicedetails.Input.body-param" @@ -5019,6 +3397,8 @@ paths: post: tags: - "tapi-common" + summary: "operates on tapi.common.GetServiceInterfacePointDetails" + description: "operates on tapi.common.GetServiceInterfacePointDetails" parameters: - in: "body" name: "tapi.common.getserviceinterfacepointdetails.Input.body-param" @@ -5068,6 +3448,8 @@ paths: post: tags: - "tapi-topology" + summary: "operates on tapi.topology.GetTopologyDetails" + description: "operates on tapi.topology.GetTopologyDetails" parameters: - in: "body" name: "tapi.topology.gettopologydetails.Input.body-param" @@ -5103,6 +3485,8 @@ paths: post: tags: - "tapi-notification" + summary: "operates on tapi.notification.UpdateNotificationSubscriptionService" + description: "operates on tapi.notification.UpdateNotificationSubscriptionService" parameters: - in: "body" name: "tapi.notification.updatenotificationsubscriptionservice.Input.body-param" @@ -5124,6 +3508,8 @@ paths: post: tags: - "tapi-common" + summary: "operates on tapi.common.UpdateServiceInterfacePoint" + description: "operates on tapi.common.UpdateServiceInterfacePoint" parameters: - in: "body" name: "tapi.common.updateserviceinterfacepoint.Input.body-param" @@ -5155,45 +3541,9 @@ definitions: enum: - "LOCKED" - "UNLOCKED" - tapi.common.BandwidthProfile: - type: "object" - properties: - committed-information-rate: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - coupling-flag: - type: "boolean" - description: "none" - default: false - bw-profile-type: - description: "none" - $ref: "#/definitions/tapi.common.BandwidthProfileType" - peak-information-rate: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - committed-burst-size: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - peak-burst-size: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - color-aware: - type: "boolean" - description: "none" - default: false - tapi.common.BandwidthProfileType: - type: "string" - enum: - - "MEF_10.x" - - "RFC_2697" - - "RFC_2698" - - "RFC_4115" tapi.common.Capacity: type: "object" properties: - bandwidth-profile: - description: "none" - $ref: "#/definitions/tapi.common.BandwidthProfile" total-size: description: "Total capacity of the TopologicalEntity in MB/s. In case of\ \ bandwidthProfile, this is expected to same as the committedInformationRate." @@ -5257,21 +3607,21 @@ definitions: properties: name: type: "array" - description: "List of names. A property of an entity with a value that is\ - \ unique in some namespace but may change during the life of the entity.\ - \ A name carries no semantics with respect to the purpose of the entity." + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." items: $ref: "#/definitions/tapi.common.NameAndValue" uuid: type: "string" description: "UUID: An identifier that is universally unique within an identifier\ - \ space, where the identifier space is itself globally unique, and immutable.\ - \ An UUID carries no semantics with respect to the purpose or state of the\ - \ entity.\r\n UUID here uses string representation as\ - \ defined in RFC 4122. The canonical representation uses lowercase characters.\r\ - \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ - \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ - \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a UUID\ + \ in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.common.LayerProtocolName: type: "string" enum: @@ -5292,9 +3642,9 @@ definitions: properties: name: type: "array" - description: "List of names. A property of an entity with a value that is\ - \ unique in some namespace but may change during the life of the entity.\ - \ A name carries no semantics with respect to the purpose of the entity." + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." items: $ref: "#/definitions/tapi.common.NameAndValue" local-id: @@ -5347,7 +3697,7 @@ definitions: $ref: "#/definitions/tapi.common.LayerProtocolName" description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ \ termination and adaptation functions of one or more transport layers. \r\ - \n The structure of LTP supports all transport protocols including\ + \n The structure of LTP supports all transport protocols including\ \ circuit and packet forms." tapi.common.ServiceInterfacePointRef: type: "object" @@ -5381,11 +3731,11 @@ definitions: type: "object" properties: termination-direction: - description: "The overall directionality of the LP. \r\n \ - \ - A BIDIRECTIONAL LP will have some SINK and/or SOURCE flowss.\r\n \ - \ - A SINK LP can only contain elements with SINK flows\ - \ or CONTRA_DIRECTION_SOURCE flows\r\n - A SOURCE LP\ - \ can only contain SOURCE flows or CONTRA_DIRECTION_SINK flows" + description: "The overall directionality of the LP. \r\n -\ + \ A BIDIRECTIONAL LP will have some SINK and/or SOURCE flowss.\r\n \ + \ - A SINK LP can only contain elements with SINK flows or CONTRA_DIRECTION_SOURCE\ + \ flows\r\n - A SOURCE LP can only contain SOURCE flows or\ + \ CONTRA_DIRECTION_SINK flows" $ref: "#/definitions/tapi.common.TerminationDirection" termination-state: description: "Indicates whether the layer is terminated and if so how." @@ -5400,12 +3750,28 @@ definitions: - "TERMINATED_BIDIRECTIONAL" - "LT_PERMENANTLY_TERMINATED" - "TERMINATION_STATE_UNKNOWN" - tapi.common.getserviceinterfacepointdetails.Input: + tapi.common.TimeRange: type: "object" properties: - sip-id-or-name: + end-time: + type: "string" + description: "none" + start-time: type: "string" description: "none" + tapi.common.getserviceinterfacepointdetails.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.common.getserviceinterfacepointdetails.Output: type: "object" properties: @@ -5423,28 +3789,19 @@ definitions: tapi.common.updateserviceinterfacepoint.Input: type: "object" properties: - sip-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" state: description: "none" $ref: "#/definitions/tapi.common.AdministrativeState" - tapi.notification.AlarmInfo: - type: "object" - properties: - perceived-severity: - description: "none" - $ref: "#/definitions/tapi.notification.PerceivedSeverityType" - probable-cause: - type: "string" - description: "none" - service-affecting: - description: "none" - $ref: "#/definitions/tapi.notification.ServiceAffecting" - is-transient: - type: "boolean" - description: "none" - default: false tapi.notification.ContextAugmentation1: type: "object" properties: @@ -5459,11 +3816,6 @@ definitions: properties: output: $ref: "#/definitions/tapi.notification.createnotificationsubscriptionservice.Output" - tapi.notification.DeleteNotificationSubscriptionService: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.notification.deletenotificationsubscriptionservice.Output" tapi.notification.GetNotificationList: type: "object" properties: @@ -5502,8 +3854,8 @@ definitions: - type: "object" properties: target-object-type: + type: "string" description: "none" - $ref: "#/definitions/tapi.notification.ObjectType" additional-text: type: "string" description: "none" @@ -5519,18 +3871,15 @@ definitions: type: "integer" format: "int32" description: "A monotonous increasing sequence number associated with the\ - \ notification.\r\n The exact semantics of how this\ - \ sequence number is assigned (per channel or subscription or source or\ - \ system) is left undefined." - tca-info: - description: "none" - $ref: "#/definitions/tapi.notification.TcaInfo" + \ notification.\r\n The exact semantics of how this sequence\ + \ number is assigned (per channel or subscription or source or system)\ + \ is left undefined." target-object-identifier: type: "string" description: "none" notification-type: + type: "string" description: "none" - $ref: "#/definitions/tapi.notification.NotificationType" target-object-name: type: "array" description: "none" @@ -5542,9 +3891,9 @@ definitions: source-indicator: description: "none" $ref: "#/definitions/tapi.notification.SourceIndicator" - alarm-info: + layer-protocol-qualifier: + type: "string" description: "none" - $ref: "#/definitions/tapi.notification.AlarmInfo" changed-attributes: type: "array" description: "none" @@ -5564,9 +3913,9 @@ definitions: stream-address: type: "string" description: "The address/location/URI of the channel/stream to which the\ - \ subscribed notifications are published.\r\n This\ - \ specifics of this is typically dependent on the implementation protocol\ - \ & mechanism and hence is typed as a string." + \ subscribed notifications are published.\r\n This specifics\ + \ of this is typically dependent on the implementation protocol & mechanism\ + \ and hence is typed as a string." description: "none" tapi.notification.NotificationContext: type: "object" @@ -5601,68 +3950,16 @@ definitions: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.ObjectType" + type: "string" supported-notification-types: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.NotificationType" + type: "string" subscription-filter: description: "none" $ref: "#/definitions/tapi.notification.SubscriptionFilter" description: "none" - tapi.notification.NotificationType: - type: "string" - enum: - - "OBJECT_CREATION" - - "OBJECT_DELETION" - - "ATTRIBUTE_VALUE_CHANGE" - - "ALARM_EVENT" - - "THRESHOLD_CROSSING_ALERT" - tapi.notification.ObjectType: - type: "string" - enum: - - "TOPOLOGY" - - "NODE" - - "LINK" - - "CONNECTION" - - "PATH" - - "CONNECTIVITY_SERVICE" - - "VIRTUAL_NETWORK_SERVICE" - - "PATH_COMPUTATION_SERVICE" - - "NODE_EDGE_POINT" - - "SERVICE_INTERFACE_POINT" - - "CONNECTION_END_POINT" - - "MAINTENANCE_ENTITY_GROUP" - - "MAINTENANCE_ENTITY" - - "MEG_END_POINT" - - "MEG_INTERMEDIATE_POINT" - - "SWITCH_CONTROL" - - "SWITCH" - - "ROUTE" - - "NODE_RULE_GROUP" - - "INTER_RULE_GROUP" - - "RULE" - - "OAM_JOB" - tapi.notification.PerceivedSeverityType: - type: "string" - enum: - - "CRITICAL" - - "MAJOR" - - "MINOR" - - "WARNING" - - "CLEARED" - tapi.notification.PerceivedTcaSeverity: - type: "string" - enum: - - "WARNING" - - "CLEAR" - tapi.notification.ServiceAffecting: - type: "string" - enum: - - "SERVICE_AFFECTING" - - "NOT_SERVICE_AFFECTING" - - "UNKNOWN" tapi.notification.SourceIndicator: type: "string" enum: @@ -5678,7 +3975,7 @@ definitions: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.NotificationType" + type: "string" requested-object-identifier: type: "array" description: "none" @@ -5699,46 +3996,13 @@ definitions: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.ObjectType" + type: "string" description: "none" tapi.notification.SubscriptionState: type: "string" enum: - "SUSPENDED" - "ACTIVE" - tapi.notification.TcaInfo: - type: "object" - properties: - threshold-crossing: - description: "none" - $ref: "#/definitions/tapi.notification.ThresholdCrossingType" - threshold-parameter: - type: "string" - description: "none" - is-transient: - type: "boolean" - description: "none" - default: false - threshold-value: - type: "integer" - format: "int32" - description: "none" - perceived-severity: - description: "none" - $ref: "#/definitions/tapi.notification.PerceivedTcaSeverity" - suspect-interval-flag: - type: "boolean" - description: "none" - default: false - measurement-interval: - type: "string" - description: "none" - tapi.notification.ThresholdCrossingType: - type: "string" - enum: - - "THRESHOLD_ABOVE" - - "THRESHOLD_BELOW" - - "CLEARED" tapi.notification.UpdateNotificationSubscriptionService: type: "object" properties: @@ -5750,6 +4014,23 @@ definitions: subscription-state: description: "none" $ref: "#/definitions/tapi.notification.SubscriptionState" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" subscription-filter: description: "none" $ref: "#/definitions/tapi.notification.SubscriptionFilter" @@ -5762,24 +4043,33 @@ definitions: tapi.notification.deletenotificationsubscriptionservice.Input: type: "object" properties: - subscription-id-or-name: + uuid: type: "string" - description: "none" - tapi.notification.deletenotificationsubscriptionservice.Output: - type: "object" - properties: - subscription-service: - description: "none" - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.notification.getnotificationlist.Input: type: "object" properties: - time-period: - type: "string" - description: "none" - subscription-id-or-name: - type: "string" + time-range: description: "none" + $ref: "#/definitions/tapi.common.TimeRange" + subscription-id: + type: "string" + description: "UUID of the associated Notification Subscription Service: An\ + \ identifier that is universally unique within an identifier space, where\ + \ the identifier space is itself globally unique, and immutable.\r\n \ + \ An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.notification.getnotificationlist.Output: type: "object" properties: @@ -5791,9 +4081,16 @@ definitions: tapi.notification.getnotificationsubscriptionservicedetails.Input: type: "object" properties: - subscription-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.notification.getnotificationsubscriptionservicedetails.Output: type: "object" properties: @@ -5815,24 +4112,38 @@ definitions: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.ObjectType" + type: "string" supported-notification-types: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.NotificationType" + type: "string" tapi.notification.updatenotificationsubscriptionservice.Input: type: "object" properties: subscription-state: description: "none" $ref: "#/definitions/tapi.notification.SubscriptionState" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" subscription-filter: description: "none" $ref: "#/definitions/tapi.notification.SubscriptionFilter" - subscription-id-or-name: - type: "string" - description: "none" tapi.notification.updatenotificationsubscriptionservice.Output: type: "object" properties: @@ -5925,7 +4236,7 @@ definitions: type: "string" description: "High frequency deviation from true periodicity of a signal and\ \ therefore a small high rate of change of transfer latency.\r\n \ - \ Applies to TDM systems (and not packet)." + \ Applies to TDM systems (and not packet)." fixed-latency-characteristic: type: "string" description: "A TopologicalEntity suffers delay caused by the realization\ @@ -5936,7 +4247,7 @@ definitions: type: "string" description: "Low frequency deviation from true periodicity of a signal and\ \ therefore a small low rate of change of transfer latency.\r\n \ - \ Applies to TDM systems (and not packet)." + \ Applies to TDM systems (and not packet)." queing-latency-characteristic: type: "string" description: "The specific queuing latency for the traffic property." @@ -5968,22 +4279,35 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.common.LayerProtocolName" - resilience-type: + restoration-policy: description: "none" - $ref: "#/definitions/tapi.topology.ResilienceType" + $ref: "#/definitions/tapi.topology.RestorationPolicy" node-edge-point: type: "array" description: "none" items: $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + protection-type: + description: "none" + $ref: "#/definitions/tapi.topology.ProtectionType" direction: - description: "The directionality of the Link. \r\n Is\ - \ applicable to simple Links where all LinkEnds are BIDIRECTIONAL (the\ - \ Link will be BIDIRECTIONAL) or UNIDIRECTIONAL (the Link will be UNIDIRECTIONAL).\ - \ \r\n Is not present in more complex cases." + description: "The directionality of the Link. \r\n Is applicable\ + \ to simple Links where all LinkEnds are BIDIRECTIONAL (the Link will\ + \ be BIDIRECTIONAL) or UNIDIRECTIONAL (the Link will be UNIDIRECTIONAL).\ + \ \r\n Is not present in more complex cases." $ref: "#/definitions/tapi.common.ForwardingDirection" description: "The Link object class models effective adjacency between two or\ \ more ForwardingDomains (FD). " + tapi.topology.NepLayerProtocolCapability: + type: "object" + properties: + layer-protocol-qualifier: + type: "string" + description: "none" + number-of-cep-instances: + type: "integer" + format: "int32" + description: "none" tapi.topology.NetworkTopologyService: allOf: - $ref: "#/definitions/tapi.common.GlobalClass" @@ -6013,16 +4337,16 @@ definitions: encap-topology: description: "none" $ref: "#/definitions/tapi.topology.TopologyRef" - owned-node-edge-point: + node-rule-group: type: "array" description: "none" items: - $ref: "#/definitions/tapi.topology.NodeEdgePoint" - node-rule-group: + $ref: "#/definitions/tapi.topology.NodeRuleGroup" + node-edge-point: type: "array" description: "none" items: - $ref: "#/definitions/tapi.topology.NodeRuleGroup" + $ref: "#/definitions/tapi.topology.NodeEdgePoint" aggregated-node-edge-point: type: "array" description: "none" @@ -6031,8 +4355,8 @@ definitions: description: "The ForwardingDomain (FD) object class models the ForwardingDomain\ \ topological component which is used to effect forwarding of transport characteristic\ \ information and offers the potential to enable forwarding. \r\n \ - \ At the lowest level of recursion, an FD (within a network element\ - \ (NE)) represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ + \ At the lowest level of recursion, an FD (within a network element (NE))\ + \ represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ \ multiple switch matrices (FDs). " tapi.topology.NodeEdgePoint: allOf: @@ -6054,6 +4378,11 @@ definitions: \ balancing/Resilience) should be considered experimental" items: $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + available-cep-layer-protocol: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NepLayerProtocolCapability" aggregated-node-edge-point: type: "array" description: "none" @@ -6065,14 +4394,9 @@ definitions: link-port-direction: description: "The orientation of defined flow at the LinkEnd." $ref: "#/definitions/tapi.common.PortDirection" - supported-cep-layer-protocol-qualifier: - type: "array" - description: "none" - items: - type: "string" description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ \ termination and adaptation functions of one or more transport layers. \r\ - \n The structure of LTP supports all transport protocols including\ + \n The structure of LTP supports all transport protocols including\ \ circuit and packet forms." tapi.topology.NodeEdgePointRef: allOf: @@ -6082,7 +4406,7 @@ definitions: node-edge-point-uuid: type: "string" description: "none" - x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:owned-node-edge-point/tapi-topology:uuid" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:node-edge-point/tapi-topology:uuid" description: "none" tapi.topology.NodeRef: allOf: @@ -6137,41 +4461,32 @@ definitions: tapi.topology.ProtectionType: type: "string" enum: - - "NO_PROTECTON" + - "NO_PROTECTION" - "ONE_PLUS_ONE_PROTECTION" - - "ONE_PLUS_ONE_PROTECTION_WITH_DYNAMIC_RESTORATION" - - "PERMANENT_ONE_PLUS_ONE_PROTECTION" - "ONE_FOR_ONE_PROTECTION" - - "DYNAMIC_RESTORATION" - - "PRE_COMPUTED_RESTORATION" - tapi.topology.ResilienceType: - type: "object" - properties: - restoration-policy: - description: "none" - $ref: "#/definitions/tapi.topology.RestorationPolicy" - protection-type: - description: "none" - $ref: "#/definitions/tapi.topology.ProtectionType" + - "ONE_FOR_N_PROTECTION" + - "M_FOR_N_PROTECTION" + - "ONE_FOR_ONE_BY_N" tapi.topology.RestorationPolicy: type: "string" enum: - "PER_DOMAIN_RESTORATION" - "END_TO_END_RESTORATION" - "NA" + - "DYNAMIC_RESTORATION" + - "PRE_COMPUTED_RESTORATION" tapi.topology.RiskCharacteristic: type: "object" properties: risk-characteristic-name: type: "string" description: "The name of the risk characteristic. The characteristic may\ - \ be related to a specific degree of closeness. \r\n \ - \ For example a particular characteristic may apply to failures that are\ - \ localized (e.g. to one side of a road) where as another characteristic\ - \ may relate to failures that have a broader impact (e.g. both sides of\ - \ a road that crosses a bridge).\r\n Depending upon the\ - \ importance of the traffic being routed different risk characteristics\ - \ will be evaluated." + \ be related to a specific degree of closeness. \r\n For\ + \ example a particular characteristic may apply to failures that are localized\ + \ (e.g. to one side of a road) where as another characteristic may relate\ + \ to failures that have a broader impact (e.g. both sides of a road that\ + \ crosses a bridge).\r\n Depending upon the importance of\ + \ the traffic being routed different risk characteristics will be evaluated." risk-identifier-list: type: "array" description: "A list of the identifiers of each physical/geographic unit (with\ @@ -6233,11 +4548,16 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.topology.Node" + boundary-node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" description: "The ForwardingDomain (FD) object class models the ForwardingDomain\ \ topological component which is used to effect forwarding of transport characteristic\ \ information and offers the potential to enable forwarding. \r\n \ - \ At the lowest level of recursion, an FD (within a network element\ - \ (NE)) represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ + \ At the lowest level of recursion, an FD (within a network element (NE))\ + \ represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ \ multiple switch matrices (FDs). " tapi.topology.TopologyContext: type: "object" @@ -6272,7 +4592,7 @@ definitions: error-characteristic: type: "string" description: "Describes the degree to which the signal propagated can be errored.\ - \ \r\n Applies to TDM systems as the errored signal will\ + \ \r\n Applies to TDM systems as the errored signal will\ \ be propagated and not packet as errored packets will be discarded." unavailable-time-characteristic: type: "string" @@ -6285,19 +4605,19 @@ definitions: delivery-order-characteristic: type: "string" description: "Describes the degree to which packets will be delivered out\ - \ of sequence.\r\n Does not apply to TDM as the TDM protocols\ + \ of sequence.\r\n Does not apply to TDM as the TDM protocols\ \ maintain strict order." repeat-delivery-characteristic: type: "string" description: "Primarily applies to packet systems where a packet may be delivered\ - \ more than once (in fault recovery for example). \r\n \ - \ It can also apply to TDM where several frames may be received twice\ - \ due to switching in a system with a large differential propagation delay." + \ more than once (in fault recovery for example). \r\n It\ + \ can also apply to TDM where several frames may be received twice due to\ + \ switching in a system with a large differential propagation delay." loss-characteristic: type: "string" description: "Describes the acceptable characteristic of lost packets where\ \ loss may result from discard due to errors or overflow.\r\n \ - \ Applies to packet systems and not TDM (as for TDM errored signals\ + \ Applies to packet systems and not TDM (as for TDM errored signals\ \ are propagated unless grossly errored and overflow/underflow turns into\ \ timing slips)." tapi.topology.TransferTimingPac: @@ -6334,12 +4654,27 @@ definitions: tapi.topology.getlinkdetails.Input: type: "object" properties: - link-id-or-name: - type: "string" - description: "none" - topology-id-or-name: + link-id: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.topology.getlinkdetails.Output: type: "object" properties: @@ -6349,12 +4684,27 @@ definitions: tapi.topology.getnodedetails.Input: type: "object" properties: - node-id-or-name: - type: "string" - description: "none" - topology-id-or-name: - type: "string" - description: "none" + node-id: + type: "string" + description: "UUID of the Node: An identifier that is universally unique within\ + \ an identifier space, where the identifier space is itself globally unique,\ + \ and immutable.\r\n An UUID carries no semantics with\ + \ respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC 4122. The canonical\ + \ representation uses lowercase characters.\r\n Pattern:\ + \ [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\ + \ \r\n Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.topology.getnodedetails.Output: type: "object" properties: @@ -6364,15 +4714,37 @@ definitions: tapi.topology.getnodeedgepointdetails.Input: type: "object" properties: - ep-id-or-name: - type: "string" - description: "none" - node-id-or-name: - type: "string" - description: "none" - topology-id-or-name: + node-id: + type: "string" + description: "UUID of the parent Node: An identifier that is universally unique\ + \ within an identifier space, where the identifier space is itself globally\ + \ unique, and immutable.\r\n An UUID carries no semantics\ + \ with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC 4122. The\ + \ canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\ + \ \r\n Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Node's Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + node-edge-point-id: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.topology.getnodeedgepointdetails.Output: type: "object" properties: @@ -6382,9 +4754,16 @@ definitions: tapi.topology.gettopologydetails.Input: type: "object" properties: - topology-id-or-name: + topology-id: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.topology.gettopologydetails.Output: type: "object" properties: diff --git a/OAS/tapi-virtual-network@2018-12-10.yaml b/OAS/tapi-virtual-network@2019-03-31.yaml similarity index 62% rename from OAS/tapi-virtual-network@2018-12-10.yaml rename to OAS/tapi-virtual-network@2019-03-31.yaml index d544647f..708c2c09 100644 --- a/OAS/tapi-virtual-network@2018-12-10.yaml +++ b/OAS/tapi-virtual-network@2019-03-31.yaml @@ -1,10 +1,73 @@ --- swagger: "2.0" info: - description: "tapi-notification,tapi-topology,tapi-common,tapi-virtual-network API\ - \ generated from yang definitions" - version: "1.0" - title: "tapi-notification,tapi-topology,tapi-common,tapi-virtual-network API" + description: "\r\n This module contains TAPI Virtual Network Model definitions.\r\ + \n Source: TapiVirtualNetwork.uml\r\n Copyright (c) 2018 Open Networking\ + \ Foundation (ONF). All rights reserved.\r\n License: This module is distributed\ + \ under the Apache License 2.0\r\n - The TAPI YANG models included in this\ + \ TAPI release are a *normative* part of the TAPI SDK.\r\n - The YANG specifications\ + \ have been generated from the corresponding UML model using the [ONF EAGLE UML2YANG\ + \ mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Notification\ + \ Model definitions.\r\n Source: TapiNotification.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Topology\ + \ Model definitions.\r\n Source: TapiTopology.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Common Model\ + \ definitions.\r\n Source: TapiCommon.uml\r\n Copyright (c) 2018\ + \ Open Networking Foundation (ONF). All rights reserved.\r\n License: This\ + \ module is distributed under the Apache License 2.0\r\n - The TAPI YANG\ + \ models included in this TAPI release are a *normative* part of the TAPI SDK.\r\ + \n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases." + version: "2.2.0" + title: "tapi-virtual-network,tapi-notification,tapi-topology,tapi-common API" host: "localhost:1234" consumes: - "application/yang-data+json" @@ -15,7 +78,8 @@ paths: get: tags: - "tapi-common" - description: "returns tapi.common.Context" + summary: "returns tapi.common.Context" + description: "none" parameters: [] responses: 200: @@ -27,7 +91,8 @@ paths: post: tags: - "tapi-common" - description: "creates tapi.common.Context" + summary: "creates tapi.common.Context" + description: "none" parameters: - in: "body" name: "tapi.common.Context.body-param" @@ -45,7 +110,8 @@ paths: put: tags: - "tapi-common" - description: "creates or updates tapi.common.Context" + summary: "creates or updates tapi.common.Context" + description: "none" parameters: - in: "body" name: "tapi.common.Context.body-param" @@ -63,7 +129,8 @@ paths: delete: tags: - "tapi-common" - description: "removes tapi.common.Context" + summary: "removes tapi.common.Context" + description: "none" parameters: [] responses: 400: @@ -74,7 +141,10 @@ paths: post: tags: - "tapi-common" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - in: "body" name: "tapi.common.NameAndValue.body-param" @@ -93,7 +163,10 @@ paths: get: tags: - "tapi-common" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "value-name" in: "path" @@ -107,33 +180,13 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-common" - description: "creates or updates tapi.common.NameAndValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "value-name" in: "path" @@ -156,7 +209,10 @@ paths: delete: tags: - "tapi-common" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "value-name" in: "path" @@ -172,7 +228,8 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.notification.NotificationContext" + summary: "returns tapi.notification.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" parameters: [] responses: 200: @@ -184,7 +241,8 @@ paths: post: tags: - "tapi-notification" - description: "creates tapi.notification.NotificationContext" + summary: "creates tapi.notification.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" parameters: - in: "body" name: "tapi.notification.NotificationContext.body-param" @@ -202,7 +260,8 @@ paths: put: tags: - "tapi-notification" - description: "creates or updates tapi.notification.NotificationContext" + summary: "creates or updates tapi.notification.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" parameters: - in: "body" name: "tapi.notification.NotificationContext.body-param" @@ -220,7 +279,8 @@ paths: delete: tags: - "tapi-notification" - description: "removes tapi.notification.NotificationContext" + summary: "removes tapi.notification.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" parameters: [] responses: 400: @@ -231,7 +291,8 @@ paths: post: tags: - "tapi-notification" - description: "creates tapi.notification.NotificationSubscriptionService" + summary: "creates tapi.notification.NotificationSubscriptionService" + description: "none" parameters: - in: "body" name: "tapi.notification.NotificationSubscriptionService.body-param" @@ -251,7 +312,8 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.notification.NotificationSubscriptionService" + summary: "returns tapi.notification.NotificationSubscriptionService" + description: "none" parameters: - name: "uuid" in: "path" @@ -265,34 +327,11 @@ paths: $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" 400: description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationSubscriptionService" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationSubscriptionService.body-param" - description: "tapi.notification.NotificationSubscriptionService to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-notification" - description: "creates or updates tapi.notification.NotificationSubscriptionService" + summary: "creates or updates tapi.notification.NotificationSubscriptionService" + description: "none" parameters: - name: "uuid" in: "path" @@ -316,7 +355,8 @@ paths: delete: tags: - "tapi-notification" - description: "removes tapi.notification.NotificationSubscriptionService" + summary: "removes tapi.notification.NotificationSubscriptionService" + description: "none" parameters: - name: "uuid" in: "path" @@ -332,7 +372,10 @@ paths: post: tags: - "tapi-notification" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -356,7 +399,10 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -375,38 +421,13 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -434,7 +455,10 @@ paths: delete: tags: - "tapi-notification" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -455,7 +479,8 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.notification.NotificationChannel" + summary: "returns tapi.notification.NotificationChannel" + description: "none" parameters: - name: "uuid" in: "path" @@ -469,96 +494,14 @@ paths: $ref: "#/definitions/tapi.notification.NotificationChannel" 400: description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationChannel.body-param" - description: "tapi.notification.NotificationChannel to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationChannel.body-param" - description: "tapi.notification.NotificationChannel to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/notification-channel/name/: - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" /data/context/notification-context/notif-subscription={uuid}/notification-channel/name={value-name}/: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -577,87 +520,12 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/: get: tags: - "tapi-notification" - description: "returns tapi.notification.Notification" + summary: "returns tapi.notification.Notification" + description: "none" parameters: - name: "uuid" in: "path" @@ -680,7 +548,8 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -704,34 +573,12 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/alarm-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.AlarmInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.AlarmInfo" - schema: - $ref: "#/definitions/tapi.notification.AlarmInfo" - 400: - description: "Internal error" /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/changed-attributes={value-name}/: get: tags: - "tapi-notification" - description: "returns tapi.notification.NameAndValueChange" + summary: "returns tapi.notification.NameAndValueChange" + description: "none" parameters: - name: "uuid" in: "path" @@ -759,7 +606,10 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -787,7 +637,8 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -811,34 +662,12 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/tca-info/: + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/: get: tags: - "tapi-notification" - description: "returns tapi.notification.TcaInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.TcaInfo" - schema: - $ref: "#/definitions/tapi.notification.TcaInfo" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/subscription-filter/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.SubscriptionFilter" + summary: "returns tapi.notification.SubscriptionFilter" + description: "none" parameters: - name: "uuid" in: "path" @@ -855,7 +684,8 @@ paths: post: tags: - "tapi-notification" - description: "creates tapi.notification.SubscriptionFilter" + summary: "creates tapi.notification.SubscriptionFilter" + description: "none" parameters: - name: "uuid" in: "path" @@ -878,7 +708,8 @@ paths: put: tags: - "tapi-notification" - description: "creates or updates tapi.notification.SubscriptionFilter" + summary: "creates or updates tapi.notification.SubscriptionFilter" + description: "none" parameters: - name: "uuid" in: "path" @@ -901,7 +732,8 @@ paths: delete: tags: - "tapi-notification" - description: "removes tapi.notification.SubscriptionFilter" + summary: "removes tapi.notification.SubscriptionFilter" + description: "none" parameters: - name: "uuid" in: "path" @@ -917,7 +749,10 @@ paths: post: tags: - "tapi-notification" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -941,7 +776,10 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -960,38 +798,13 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -1019,7 +832,10 @@ paths: delete: tags: - "tapi-notification" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -1040,7 +856,8 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.notification.Notification" + summary: "returns tapi.notification.Notification" + description: "none" parameters: - name: "uuid" in: "path" @@ -1058,7 +875,8 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -1077,29 +895,12 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/notification-context/notification={uuid}/alarm-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.AlarmInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.AlarmInfo" - schema: - $ref: "#/definitions/tapi.notification.AlarmInfo" - 400: - description: "Internal error" /data/context/notification-context/notification={uuid}/changed-attributes={value-name}/: get: tags: - "tapi-notification" - description: "returns tapi.notification.NameAndValueChange" + summary: "returns tapi.notification.NameAndValueChange" + description: "none" parameters: - name: "uuid" in: "path" @@ -1122,7 +923,10 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -1145,7 +949,8 @@ paths: get: tags: - "tapi-notification" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "none" parameters: - name: "uuid" in: "path" @@ -1164,29 +969,12 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/notification-context/notification={uuid}/tca-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.TcaInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.TcaInfo" - schema: - $ref: "#/definitions/tapi.notification.TcaInfo" - 400: - description: "Internal error" /data/context/service-interface-point/: post: tags: - "tapi-common" - description: "creates tapi.common.ServiceInterfacePoint" + summary: "creates tapi.common.ServiceInterfacePoint" + description: "none" parameters: - in: "body" name: "tapi.common.ServiceInterfacePoint.body-param" @@ -1205,7 +993,8 @@ paths: get: tags: - "tapi-common" - description: "returns tapi.common.ServiceInterfacePoint" + summary: "returns tapi.common.ServiceInterfacePoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -1219,33 +1008,11 @@ paths: $ref: "#/definitions/tapi.common.ServiceInterfacePoint" 400: description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.ServiceInterfacePoint.body-param" - description: "tapi.common.ServiceInterfacePoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-common" - description: "creates or updates tapi.common.ServiceInterfacePoint" + summary: "creates or updates tapi.common.ServiceInterfacePoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -1268,7 +1035,8 @@ paths: delete: tags: - "tapi-common" - description: "removes tapi.common.ServiceInterfacePoint" + summary: "removes tapi.common.ServiceInterfacePoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -1284,7 +1052,8 @@ paths: get: tags: - "tapi-common" - description: "returns tapi.common.Capacity" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" @@ -1298,101 +1067,13 @@ paths: $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/committed-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" /data/context/service-interface-point={uuid}/available-capacity/total-size/: get: tags: - "tapi-common" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -1410,7 +1091,10 @@ paths: post: tags: - "tapi-common" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -1434,7 +1118,10 @@ paths: get: tags: - "tapi-common" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -1453,38 +1140,13 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-common" - description: "creates or updates tapi.common.NameAndValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -1512,7 +1174,10 @@ paths: delete: tags: - "tapi-common" - description: "removes tapi.common.NameAndValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -1533,7 +1198,9 @@ paths: get: tags: - "tapi-common" - description: "returns tapi.common.Capacity" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" @@ -1547,11 +1214,13 @@ paths: $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/: + /data/context/service-interface-point={uuid}/total-potential-capacity/total-size/: get: tags: - "tapi-common" - description: "returns tapi.common.BandwidthProfile" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -1560,136 +1229,49 @@ paths: type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/: + /data/context/topology-context/: get: tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" + - "tapi-topology" + summary: "returns tapi.topology.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: [] responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.TopologyContext" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.TopologyContext" 400: description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/: - get: + post: tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" + - "tapi-topology" + summary: "creates tapi.topology.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" + - in: "body" + name: "tapi.topology.TopologyContext.body-param" + description: "tapi.topology.TopologyContext to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.topology.TopologyContext" responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" + 201: + description: "Object created" 400: description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: + 409: + description: "Object already exists" + put: tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/total-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.TopologyContext" - parameters: [] - responses: - 200: - description: "tapi.topology.TopologyContext" - schema: - $ref: "#/definitions/tapi.topology.TopologyContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-topology" - description: "creates tapi.topology.TopologyContext" - parameters: - - in: "body" - name: "tapi.topology.TopologyContext.body-param" - description: "tapi.topology.TopologyContext to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.TopologyContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-topology" - description: "creates or updates tapi.topology.TopologyContext" + - "tapi-topology" + summary: "creates or updates tapi.topology.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" parameters: - in: "body" name: "tapi.topology.TopologyContext.body-param" @@ -1707,7 +1289,8 @@ paths: delete: tags: - "tapi-topology" - description: "removes tapi.topology.TopologyContext" + summary: "removes tapi.topology.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" parameters: [] responses: 400: @@ -1718,7 +1301,8 @@ paths: get: tags: - "tapi-topology" - description: "returns tapi.topology.NetworkTopologyService" + summary: "returns tapi.topology.NetworkTopologyService" + description: "none" parameters: [] responses: 200: @@ -1731,7 +1315,10 @@ paths: get: tags: - "tapi-topology" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "value-name" in: "path" @@ -1749,7 +1336,8 @@ paths: get: tags: - "tapi-topology" - description: "returns tapi.topology.TopologyRef" + summary: "returns tapi.topology.TopologyRef" + description: "none" parameters: - name: "topology-uuid" in: "path" @@ -1767,7 +1355,8 @@ paths: get: tags: - "tapi-topology" - description: "returns tapi.topology.Topology" + summary: "returns tapi.topology.Topology" + description: "none" parameters: - name: "uuid" in: "path" @@ -1781,126 +1370,46 @@ paths: $ref: "#/definitions/tapi.topology.Topology" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Link" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Link" - schema: - $ref: "#/definitions/tapi.topology.Link" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/committed-burst-size/: + /data/context/topology-context/topology={uuid}/boundary-node-edge-point={topology-uuid},{node-uuid},{node-edge-point-uuid}/: get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "link-uuid" + - name: "topology-uuid" in: "path" - description: "Id of link" + description: "Id of boundary-node-edge-point" required: true type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" + - name: "node-uuid" in: "path" - description: "Id of topology" + description: "Id of boundary-node-edge-point" required: true type: "string" - - name: "link-uuid" + - name: "node-edge-point-uuid" in: "path" - description: "Id of link" + description: "Id of boundary-node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.NodeEdgePointRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/peak-burst-size/: + /data/context/topology-context/topology={uuid}/link={link-uuid}/: get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.Link" + description: "none" parameters: - name: "uuid" in: "path" @@ -1914,16 +1423,17 @@ paths: type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.Link" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.Link" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/peak-information-rate/: + /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/: get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" @@ -1937,16 +1447,18 @@ paths: type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/total-size/: get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -1969,7 +1481,9 @@ paths: get: tags: - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" @@ -1997,7 +1511,9 @@ paths: get: tags: - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" @@ -2025,7 +1541,10 @@ paths: get: tags: - "tapi-topology" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -2053,7 +1572,8 @@ paths: : get: tags: - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -2087,34 +1607,13 @@ paths: $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/resilience-type/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.ResilienceType" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.ResilienceType" - schema: - $ref: "#/definitions/tapi.topology.ResilienceType" - 400: - description: "Internal error" /data/context/topology-context/topology={uuid}/link={link-uuid}/risk-characteristic={risk-characteristic-name}/: get: tags: - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." parameters: - name: "uuid" in: "path" @@ -2142,7 +1641,9 @@ paths: get: tags: - "tapi-topology" - description: "returns tapi.common.Capacity" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" @@ -2161,11 +1662,13 @@ paths: $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/: + /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/total-size/: get: tags: - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -2179,16 +1682,18 @@ paths: type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: + /data/context/topology-context/topology={uuid}/link={link-uuid}/validation-mechanism={validation-mechanism}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.ValidationMechanism" + description: "Provides details of the specific validation mechanism(s) used\ + \ to confirm the presence of an intended topologicalEntity." parameters: - name: "uuid" in: "path" @@ -2200,161 +1705,163 @@ paths: description: "Id of link" required: true type: "string" + - name: "validation-mechanism" + in: "path" + description: "Id of validation-mechanism" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.ValidationMechanism" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.ValidationMechanism" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: + /data/context/topology-context/topology={uuid}/name={value-name}/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "link-uuid" + - name: "value-name" in: "path" - description: "Id of link" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: + /data/context/topology-context/topology={uuid}/node={node-uuid}/: get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.Node" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "link-uuid" + - name: "node-uuid" in: "path" - description: "Id of link" + description: "Id of node" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.Node" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.Node" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "link-uuid" + - name: "node-uuid" in: "path" - description: "Id of link" + description: "Id of node" required: true type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" + - name: "topology-uuid" in: "path" - description: "Id of topology" + description: "Id of aggregated-node-edge-point" required: true type: "string" - - name: "link-uuid" + - name: "aggregated-node-edge-point-node-uuid" in: "path" - description: "Id of link" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.NodeEdgePointRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/validation-mechanism={validation-mechanism}/: + /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/: get: tags: - "tapi-topology" - description: "returns tapi.topology.ValidationMechanism" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "validation-mechanism" + - name: "node-uuid" in: "path" - description: "Id of validation-mechanism" + description: "Id of node" required: true type: "string" responses: 200: - description: "tapi.topology.ValidationMechanism" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.topology.ValidationMechanism" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/name={value-name}/: + /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/total-size/: get: tags: - "tapi-topology" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - - name: "value-name" + - name: "node-uuid" in: "path" - description: "Id of name" + description: "Id of node" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/: + /data/context/topology-context/topology={uuid}/node={node-uuid}/cost-characteristic={cost-name}/: get: tags: - "tapi-topology" - description: "returns tapi.topology.Node" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" @@ -2366,18 +1873,24 @@ paths: description: "Id of node" required: true type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" responses: 200: - description: "tapi.topology.Node" + description: "tapi.topology.CostCharacteristic" schema: - $ref: "#/definitions/tapi.topology.Node" + $ref: "#/definitions/tapi.topology.CostCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/encap-topology/: + get: tags: - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" + summary: "returns tapi.topology.TopologyRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -2389,33 +1902,20 @@ paths: description: "Id of node" required: true type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "aggregated-node-edge-point-node-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" responses: 200: - description: "tapi.topology.NodeEdgePointRef" + description: "tapi.topology.TopologyRef" schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + $ref: "#/definitions/tapi.topology.TopologyRef" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/: + /data/context/topology-context/topology={uuid}/node={node-uuid}/latency-characteristic={traffic-property-name}/: get: tags: - "tapi-topology" - description: "returns tapi.common.Capacity" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" @@ -2427,18 +1927,26 @@ paths: description: "Id of node" required: true type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" responses: 200: - description: "tapi.common.Capacity" + description: "tapi.topology.LatencyCharacteristic" schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/: + /data/context/topology-context/topology={uuid}/node={node-uuid}/name={value-name}/: get: tags: - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -2450,18 +1958,24 @@ paths: description: "Id of node" required: true type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/committed-burst-size/: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/: get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.NodeEdgePoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -2473,18 +1987,24 @@ paths: description: "Id of node" required: true type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.NodeEdgePoint" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.NodeEdgePoint" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{aggregated-node-edge-point-node-edge-point-uuid}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -2496,18 +2016,39 @@ paths: description: "Id of node" required: true type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "aggregated-node-edge-point-node-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "aggregated-node-edge-point-node-edge-point-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.NodeEdgePointRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/peak-burst-size/: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-capacity/: get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" @@ -2519,18 +2060,25 @@ paths: description: "Id of node" required: true type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/peak-information-rate/: - get: + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-capacity/total-size/ + : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -2542,6 +2090,11 @@ paths: description: "Id of node" required: true type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" responses: 200: description: "tapi.common.CapacityValue" @@ -2549,11 +2102,12 @@ paths: $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/total-size/: - get: + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-cep-layer-protocol={layer-protocol-qualifier}/ + : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.NepLayerProtocolCapability" + description: "none" parameters: - name: "uuid" in: "path" @@ -2565,18 +2119,31 @@ paths: description: "Id of node" required: true type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "layer-protocol-qualifier" + in: "path" + description: "Id of available-cep-layer-protocol" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.NepLayerProtocolCapability" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.NepLayerProtocolCapability" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/cost-characteristic={cost-name}/: - get: + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/mapped-service-interface-point={service-interface-point-uuid}/ + : get: tags: - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "NodeEdgePoint mapped to more than ServiceInterfacePoint (slicing/virtualizing)\ + \ or a ServiceInterfacePoint mapped to more than one NodeEdgePoint (load balancing/Resilience)\ + \ should be considered experimental" parameters: - name: "uuid" in: "path" @@ -2588,23 +2155,31 @@ paths: description: "Id of node" required: true type: "string" - - name: "cost-name" + - name: "node-edge-point-uuid" in: "path" - description: "Id of cost-characteristic" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "service-interface-point-uuid" + in: "path" + description: "Id of mapped-service-interface-point" required: true type: "string" responses: 200: - description: "tapi.topology.CostCharacteristic" + description: "tapi.common.ServiceInterfacePointRef" schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/encap-topology/: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/name={value-name}/: get: tags: - "tapi-topology" - description: "returns tapi.topology.TopologyRef" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -2616,18 +2191,30 @@ paths: description: "Id of node" required: true type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" responses: 200: - description: "tapi.topology.TopologyRef" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.topology.TopologyRef" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/latency-characteristic={traffic-property-name}/: - get: + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/total-potential-capacity/ + : get: tags: - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" @@ -2639,23 +2226,25 @@ paths: description: "Id of node" required: true type: "string" - - name: "traffic-property-name" + - name: "node-edge-point-uuid" in: "path" - description: "Id of latency-characteristic" + description: "Id of node-edge-point" required: true type: "string" responses: 200: - description: "tapi.topology.LatencyCharacteristic" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/name={value-name}/: - get: + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/total-potential-capacity/total-size/ + : get: tags: - "tapi-topology" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -2667,23 +2256,24 @@ paths: description: "Id of node" required: true type: "string" - - name: "value-name" + - name: "node-edge-point-uuid" in: "path" - description: "Id of name" + description: "Id of node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/: get: tags: - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroup" + summary: "returns tapi.topology.NodeRuleGroup" + description: "none" parameters: - name: "uuid" in: "path" @@ -2711,7 +2301,8 @@ paths: get: tags: - "tapi-topology" - description: "returns tapi.common.Capacity" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" @@ -2735,11 +2326,13 @@ paths: $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/total-size/ : get: tags: - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -2758,16 +2351,17 @@ paths: type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/composed-rule-group={topology-uuid},{composed-rule-group-node-uuid},{composed-rule-group-node-rule-group-uuid}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.NodeRuleGroupRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -2784,46 +2378,35 @@ paths: description: "Id of node-rule-group" required: true type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" + - name: "topology-uuid" in: "path" - description: "Id of topology" + description: "Id of composed-rule-group" required: true type: "string" - - name: "node-uuid" + - name: "composed-rule-group-node-uuid" in: "path" - description: "Id of node" + description: "Id of composed-rule-group" required: true type: "string" - - name: "node-rule-group-uuid" + - name: "composed-rule-group-node-rule-group-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of composed-rule-group" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.NodeRuleGroupRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/cost-characteristic={cost-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" @@ -2840,18 +2423,24 @@ paths: description: "Id of node-rule-group" required: true type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.CostCharacteristic" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.CostCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.InterRuleGroup" + description: "none" parameters: - name: "uuid" in: "path" @@ -2868,46 +2457,24 @@ paths: description: "Id of node-rule-group" required: true type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of node-rule-group" + description: "Id of inter-rule-group" required: true type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.InterRuleGroup" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.InterRuleGroup" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/composed-rule-group={topology-uuid},{composed-rule-group-node-uuid},{composed-rule-group-node-rule-group-uuid}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/associated-node-rule-group={topology-uuid},{associated-node-rule-group-node-uuid},{associated-node-rule-group-node-rule-group-uuid}/ : get: tags: - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroupRef" + summary: "returns tapi.topology.NodeRuleGroupRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -2924,19 +2491,24 @@ paths: description: "Id of node-rule-group" required: true type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" - name: "topology-uuid" in: "path" - description: "Id of composed-rule-group" + description: "Id of associated-node-rule-group" required: true type: "string" - - name: "composed-rule-group-node-uuid" + - name: "associated-node-rule-group-node-uuid" in: "path" - description: "Id of composed-rule-group" + description: "Id of associated-node-rule-group" required: true type: "string" - - name: "composed-rule-group-node-rule-group-uuid" + - name: "associated-node-rule-group-node-rule-group-uuid" in: "path" - description: "Id of composed-rule-group" + description: "Id of associated-node-rule-group" required: true type: "string" responses: @@ -2946,11 +2518,12 @@ paths: $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/cost-characteristic={cost-name}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/ : get: tags: - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." parameters: - name: "uuid" in: "path" @@ -2967,23 +2540,25 @@ paths: description: "Id of node-rule-group" required: true type: "string" - - name: "cost-name" + - name: "inter-rule-group-uuid" in: "path" - description: "Id of cost-characteristic" + description: "Id of inter-rule-group" required: true type: "string" responses: 200: - description: "tapi.topology.CostCharacteristic" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/total-size/ : get: tags: - "tapi-topology" - description: "returns tapi.topology.InterRuleGroup" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -3007,16 +2582,18 @@ paths: type: "string" responses: 200: - description: "tapi.topology.InterRuleGroup" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.topology.InterRuleGroup" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/associated-node-rule-group={topology-uuid},{associated-node-rule-group-node-uuid},{associated-node-rule-group-node-rule-group-uuid}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/cost-characteristic={cost-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroupRef" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" @@ -3038,33 +2615,25 @@ paths: description: "Id of inter-rule-group" required: true type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of associated-node-rule-group" - required: true - type: "string" - - name: "associated-node-rule-group-node-uuid" - in: "path" - description: "Id of associated-node-rule-group" - required: true - type: "string" - - name: "associated-node-rule-group-node-rule-group-uuid" + - name: "cost-name" in: "path" - description: "Id of associated-node-rule-group" + description: "Id of cost-characteristic" required: true type: "string" responses: 200: - description: "tapi.topology.NodeRuleGroupRef" + description: "tapi.topology.CostCharacteristic" schema: - $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + $ref: "#/definitions/tapi.topology.CostCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/latency-characteristic={traffic-property-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.Capacity" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" @@ -3086,18 +2655,26 @@ paths: description: "Id of inter-rule-group" required: true type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" responses: 200: - description: "tapi.common.Capacity" + description: "tapi.topology.LatencyCharacteristic" schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/name={value-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -3119,18 +2696,25 @@ paths: description: "Id of inter-rule-group" required: true type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." parameters: - name: "uuid" in: "path" @@ -3152,18 +2736,24 @@ paths: description: "Id of inter-rule-group" required: true type: "string" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-characteristic" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.RiskCharacteristic" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.RiskCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.topology.Rule" + description: "none" parameters: - name: "uuid" in: "path" @@ -3185,18 +2775,26 @@ paths: description: "Id of inter-rule-group" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.topology.Rule" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.Rule" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/name={value-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -3218,18 +2816,30 @@ paths: description: "Id of inter-rule-group" required: true type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" @@ -3253,16 +2863,18 @@ paths: type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/total-size/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/total-size/ : get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -3291,11 +2903,13 @@ paths: $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/cost-characteristic={cost-name}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/latency-characteristic={traffic-property-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" @@ -3312,28 +2926,26 @@ paths: description: "Id of node-rule-group" required: true type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "cost-name" + - name: "traffic-property-name" in: "path" - description: "Id of cost-characteristic" + description: "Id of latency-characteristic" required: true type: "string" responses: 200: - description: "tapi.topology.CostCharacteristic" + description: "tapi.topology.LatencyCharacteristic" schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/latency-characteristic={traffic-property-name}/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/name={value-name}/: + get: tags: - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -3350,28 +2962,24 @@ paths: description: "Id of node-rule-group" required: true type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "traffic-property-name" + - name: "value-name" in: "path" - description: "Id of latency-characteristic" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.topology.LatencyCharacteristic" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/name={value-name}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/node-edge-point={topology-uuid},{node-edge-point-node-uuid},{node-edge-point-uuid}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -3388,28 +2996,35 @@ paths: description: "Id of node-rule-group" required: true type: "string" - - name: "inter-rule-group-uuid" + - name: "topology-uuid" in: "path" - description: "Id of inter-rule-group" + description: "Id of node-edge-point" required: true type: "string" - - name: "value-name" + - name: "node-edge-point-node-uuid" in: "path" - description: "Id of name" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" required: true type: "string" responses: 200: - description: "tapi.common.NameAndValue" + description: "tapi.topology.NodeEdgePointRef" schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." parameters: - name: "uuid" in: "path" @@ -3426,11 +3041,6 @@ paths: description: "Id of node-rule-group" required: true type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - name: "risk-characteristic-name" in: "path" description: "Id of risk-characteristic" @@ -3443,11 +3053,12 @@ paths: $ref: "#/definitions/tapi.topology.RiskCharacteristic" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/: + get: tags: - "tapi-topology" - description: "returns tapi.topology.Rule" + summary: "returns tapi.topology.Rule" + description: "none" parameters: - name: "uuid" in: "path" @@ -3464,11 +3075,6 @@ paths: description: "Id of node-rule-group" required: true type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - name: "local-id" in: "path" description: "Id of rule" @@ -3481,11 +3087,14 @@ paths: $ref: "#/definitions/tapi.topology.Rule" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/name={value-name}/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/name={value-name}/ : get: tags: - "tapi-topology" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -3502,11 +3111,6 @@ paths: description: "Id of node-rule-group" required: true type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - name: "local-id" in: "path" description: "Id of rule" @@ -3524,11 +3128,13 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/ : get: tags: - "tapi-topology" - description: "returns tapi.common.Capacity" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" @@ -3545,11 +3151,6 @@ paths: description: "Id of node-rule-group" required: true type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" responses: 200: description: "tapi.common.Capacity" @@ -3557,11 +3158,13 @@ paths: $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/ + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/total-size/ : get: tags: - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -3578,23 +3181,20 @@ paths: description: "Id of node-rule-group" required: true type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.common.CapacityValue" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: + /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/: + get: tags: - "tapi-topology" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." parameters: - name: "uuid" in: "path" @@ -3606,1865 +3206,64 @@ paths: description: "Id of node" required: true type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/latency-characteristic={traffic-property-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/node-edge-point={topology-uuid},{node-edge-point-node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-edge-point-node-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Rule" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of rule" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Rule" - schema: - $ref: "#/definitions/tapi.topology.Rule" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/name={value-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of rule" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePoint" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePoint" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "aggregated-node-edge-point-node-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/mapped-service-interface-point={service-interface-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.ServiceInterfacePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "service-interface-point-uuid" - in: "path" - description: "Id of mapped-service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.ServiceInterfacePointRef" - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/name={value-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/virtual-network-context/: - get: - tags: - - "tapi-virtual-network" - description: "returns tapi.virtual.network.VirtualNetworkContext" - parameters: [] - responses: - 200: - description: "tapi.virtual.network.VirtualNetworkContext" - schema: - $ref: "#/definitions/tapi.virtual.network.VirtualNetworkContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-virtual-network" - description: "creates tapi.virtual.network.VirtualNetworkContext" - parameters: - - in: "body" - name: "tapi.virtual.network.VirtualNetworkContext.body-param" - description: "tapi.virtual.network.VirtualNetworkContext to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.virtual.network.VirtualNetworkContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-virtual-network" - description: "creates or updates tapi.virtual.network.VirtualNetworkContext" - parameters: - - in: "body" - name: "tapi.virtual.network.VirtualNetworkContext.body-param" - description: "tapi.virtual.network.VirtualNetworkContext to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.virtual.network.VirtualNetworkContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-virtual-network" - description: "removes tapi.virtual.network.VirtualNetworkContext" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/virtual-network-context/virtual-nw-service/: - post: - tags: - - "tapi-virtual-network" - description: "creates tapi.virtual.network.VirtualNetworkService" - parameters: - - in: "body" - name: "tapi.virtual.network.VirtualNetworkService.body-param" - description: "tapi.virtual.network.VirtualNetworkService to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.virtual.network.VirtualNetworkService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/virtual-network-context/virtual-nw-service={uuid}/: - get: - tags: - - "tapi-virtual-network" - description: "returns tapi.virtual.network.VirtualNetworkService" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - responses: - 200: - description: "tapi.virtual.network.VirtualNetworkService" - schema: - $ref: "#/definitions/tapi.virtual.network.VirtualNetworkService" - 400: - description: "Internal error" - post: - tags: - - "tapi-virtual-network" - description: "creates tapi.virtual.network.VirtualNetworkService" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - in: "body" - name: "tapi.virtual.network.VirtualNetworkService.body-param" - description: "tapi.virtual.network.VirtualNetworkService to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.virtual.network.VirtualNetworkService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-virtual-network" - description: "creates or updates tapi.virtual.network.VirtualNetworkService" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - in: "body" - name: "tapi.virtual.network.VirtualNetworkService.body-param" - description: "tapi.virtual.network.VirtualNetworkService to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.virtual.network.VirtualNetworkService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-virtual-network" - description: "removes tapi.virtual.network.VirtualNetworkService" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/virtual-network-context/virtual-nw-service={uuid}/end-point/: - post: - tags: - - "tapi-virtual-network" - description: "creates tapi.virtual.network.VirtualNetworkServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - in: "body" - name: "tapi.virtual.network.VirtualNetworkServiceEndPoint.body-param" - description: "tapi.virtual.network.VirtualNetworkServiceEndPoint to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.virtual.network.VirtualNetworkServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/virtual-network-context/virtual-nw-service={uuid}/end-point={local-id}/: - get: - tags: - - "tapi-virtual-network" - description: "returns tapi.virtual.network.VirtualNetworkServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.virtual.network.VirtualNetworkServiceEndPoint" - schema: - $ref: "#/definitions/tapi.virtual.network.VirtualNetworkServiceEndPoint" - 400: - description: "Internal error" - post: - tags: - - "tapi-virtual-network" - description: "creates tapi.virtual.network.VirtualNetworkServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.virtual.network.VirtualNetworkServiceEndPoint.body-param" - description: "tapi.virtual.network.VirtualNetworkServiceEndPoint to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.virtual.network.VirtualNetworkServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-virtual-network" - description: "creates or updates tapi.virtual.network.VirtualNetworkServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.virtual.network.VirtualNetworkServiceEndPoint.body-param" - description: "tapi.virtual.network.VirtualNetworkServiceEndPoint to be added\ - \ or updated" - required: false - schema: - $ref: "#/definitions/tapi.virtual.network.VirtualNetworkServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-virtual-network" - description: "removes tapi.virtual.network.VirtualNetworkServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/virtual-network-context/virtual-nw-service={uuid}/end-point={local-id}/name/: - post: - tags: - - "tapi-virtual-network" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/virtual-network-context/virtual-nw-service={uuid}/end-point={local-id}/name={value-name}/: - get: - tags: - - "tapi-virtual-network" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-virtual-network" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-virtual-network" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-virtual-network" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/virtual-network-context/virtual-nw-service={uuid}/end-point={local-id}/service-interface-point/: - get: - tags: - - "tapi-virtual-network" - description: "returns tapi.common.ServiceInterfacePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.ServiceInterfacePointRef" - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" - 400: - description: "Internal error" - /data/context/virtual-network-context/virtual-nw-service={uuid}/name/: - post: - tags: - - "tapi-virtual-network" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/virtual-network-context/virtual-nw-service={uuid}/name={value-name}/: - get: - tags: - - "tapi-virtual-network" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-virtual-network" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-virtual-network" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: + /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/total-size/: + get: tags: - - "tapi-virtual-network" - description: "removes tapi.common.NameAndValue" + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" - description: "Id of virtual-nw-service" + description: "Id of topology" required: true type: "string" - - name: "value-name" + - name: "node-uuid" in: "path" - description: "Id of name" + description: "Id of node" required: true type: "string" responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/virtual-network-context/virtual-nw-service={uuid}/state/: + /data/context/virtual-network-context/: get: tags: - "tapi-virtual-network" - description: "returns tapi.common.AdminStatePac" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" + summary: "returns tapi.virtual.network.VirtualNetworkContext" + description: "Augments the base TAPI Context with VirtualNetworkService information" + parameters: [] responses: 200: - description: "tapi.common.AdminStatePac" + description: "tapi.virtual.network.VirtualNetworkContext" schema: - $ref: "#/definitions/tapi.common.AdminStatePac" + $ref: "#/definitions/tapi.virtual.network.VirtualNetworkContext" 400: description: "Internal error" post: tags: - "tapi-virtual-network" - description: "creates tapi.common.AdminStatePac" + summary: "creates tapi.virtual.network.VirtualNetworkContext" + description: "Augments the base TAPI Context with VirtualNetworkService information" parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - in: "body" - name: "tapi.common.AdminStatePac.body-param" - description: "tapi.common.AdminStatePac to be added to list" + name: "tapi.virtual.network.VirtualNetworkContext.body-param" + description: "tapi.virtual.network.VirtualNetworkContext to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.AdminStatePac" + $ref: "#/definitions/tapi.virtual.network.VirtualNetworkContext" responses: 201: description: "Object created" @@ -5475,19 +3274,15 @@ paths: put: tags: - "tapi-virtual-network" - description: "creates or updates tapi.common.AdminStatePac" + summary: "creates or updates tapi.virtual.network.VirtualNetworkContext" + description: "Augments the base TAPI Context with VirtualNetworkService information" parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - in: "body" - name: "tapi.common.AdminStatePac.body-param" - description: "tapi.common.AdminStatePac to be added or updated" + name: "tapi.virtual.network.VirtualNetworkContext.body-param" + description: "tapi.virtual.network.VirtualNetworkContext to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.AdminStatePac" + $ref: "#/definitions/tapi.virtual.network.VirtualNetworkContext" responses: 201: description: "Object created" @@ -5498,54 +3293,27 @@ paths: delete: tags: - "tapi-virtual-network" - description: "removes tapi.common.AdminStatePac" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" + summary: "removes tapi.virtual.network.VirtualNetworkContext" + description: "Augments the base TAPI Context with VirtualNetworkService information" + parameters: [] responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/virtual-network-context/virtual-nw-service={uuid}/topology/: - get: - tags: - - "tapi-virtual-network" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint/: + /data/context/virtual-network-context/virtual-nw-service/: post: tags: - "tapi-virtual-network" - description: "creates tapi.virtual.network.VirtualNetworkConstraint" + summary: "creates tapi.virtual.network.VirtualNetworkService" + description: "none" parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - in: "body" - name: "tapi.virtual.network.VirtualNetworkConstraint.body-param" - description: "tapi.virtual.network.VirtualNetworkConstraint to be added to\ - \ list" + name: "tapi.virtual.network.VirtualNetworkService.body-param" + description: "tapi.virtual.network.VirtualNetworkService to be added to list" required: false schema: - $ref: "#/definitions/tapi.virtual.network.VirtualNetworkConstraint" + $ref: "#/definitions/tapi.virtual.network.VirtualNetworkService" responses: 201: description: "Object created" @@ -5553,80 +3321,42 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint={local-id}/: + /data/context/virtual-network-context/virtual-nw-service={uuid}/: get: tags: - "tapi-virtual-network" - description: "returns tapi.virtual.network.VirtualNetworkConstraint" + summary: "returns tapi.virtual.network.VirtualNetworkService" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of virtual-nw-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" responses: 200: - description: "tapi.virtual.network.VirtualNetworkConstraint" + description: "tapi.virtual.network.VirtualNetworkService" schema: - $ref: "#/definitions/tapi.virtual.network.VirtualNetworkConstraint" - 400: - description: "Internal error" - post: - tags: - - "tapi-virtual-network" - description: "creates tapi.virtual.network.VirtualNetworkConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - - in: "body" - name: "tapi.virtual.network.VirtualNetworkConstraint.body-param" - description: "tapi.virtual.network.VirtualNetworkConstraint to be added to\ - \ list" - required: false - schema: - $ref: "#/definitions/tapi.virtual.network.VirtualNetworkConstraint" - responses: - 201: - description: "Object created" + $ref: "#/definitions/tapi.virtual.network.VirtualNetworkService" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-virtual-network" - description: "creates or updates tapi.virtual.network.VirtualNetworkConstraint" + summary: "creates or updates tapi.virtual.network.VirtualNetworkService" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of virtual-nw-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - in: "body" - name: "tapi.virtual.network.VirtualNetworkConstraint.body-param" - description: "tapi.virtual.network.VirtualNetworkConstraint to be added or\ - \ updated" + name: "tapi.virtual.network.VirtualNetworkService.body-param" + description: "tapi.virtual.network.VirtualNetworkService to be added or updated" required: false schema: - $ref: "#/definitions/tapi.virtual.network.VirtualNetworkConstraint" + $ref: "#/definitions/tapi.virtual.network.VirtualNetworkService" responses: 201: description: "Object created" @@ -5637,106 +3367,38 @@ paths: delete: tags: - "tapi-virtual-network" - description: "removes tapi.virtual.network.VirtualNetworkConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint={local-id}/cost-characteristic/: - post: - tags: - - "tapi-virtual-network" - description: "creates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint={local-id}/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-virtual-network" - description: "returns tapi.topology.CostCharacteristic" + summary: "removes tapi.virtual.network.VirtualNetworkService" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of virtual-nw-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" 400: description: "Internal error" + 204: + description: "Object deleted" + /data/context/virtual-network-context/virtual-nw-service={uuid}/end-point/: post: tags: - "tapi-virtual-network" - description: "creates tapi.topology.CostCharacteristic" + summary: "creates tapi.virtual.network.VirtualNetworkServiceEndPoint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of virtual-nw-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" + name: "tapi.virtual.network.VirtualNetworkServiceEndPoint.body-param" + description: "tapi.virtual.network.VirtualNetworkServiceEndPoint to be added\ + \ to list" required: false schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" + $ref: "#/definitions/tapi.virtual.network.VirtualNetworkServiceEndPoint" responses: 201: description: "Object created" @@ -5744,10 +3406,12 @@ paths: description: "Internal error" 409: description: "Object already exists" - put: + /data/context/virtual-network-context/virtual-nw-service={uuid}/end-point={local-id}/: + get: tags: - "tapi-virtual-network" - description: "creates or updates tapi.topology.CostCharacteristic" + summary: "returns tapi.virtual.network.VirtualNetworkServiceEndPoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -5756,31 +3420,21 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" + description: "Id of end-point" required: true type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" responses: - 201: - description: "Object created" + 200: + description: "tapi.virtual.network.VirtualNetworkServiceEndPoint" + schema: + $ref: "#/definitions/tapi.virtual.network.VirtualNetworkServiceEndPoint" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + put: tags: - "tapi-virtual-network" - description: "removes tapi.topology.CostCharacteristic" + summary: "creates or updates tapi.virtual.network.VirtualNetworkServiceEndPoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -5789,24 +3443,28 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" + description: "Id of end-point" required: true type: "string" + - in: "body" + name: "tapi.virtual.network.VirtualNetworkServiceEndPoint.body-param" + description: "tapi.virtual.network.VirtualNetworkServiceEndPoint to be added\ + \ or updated" + required: false + schema: + $ref: "#/definitions/tapi.virtual.network.VirtualNetworkServiceEndPoint" responses: + 201: + description: "Object created" 400: description: "Internal error" 204: - description: "Object deleted" - ? /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint={local-id}/diversity-exclusion={virtual-nw-service-uuid}/ - : get: + description: "Object modified" + delete: tags: - "tapi-virtual-network" - description: "returns tapi.virtual.network.VirtualNwServiceRef" + summary: "removes tapi.virtual.network.VirtualNetworkServiceEndPoint" + description: "none" parameters: - name: "uuid" in: "path" @@ -5815,26 +3473,22 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - - name: "virtual-nw-service-uuid" - in: "path" - description: "Id of diversity-exclusion" + description: "Id of end-point" required: true type: "string" responses: - 200: - description: "tapi.virtual.network.VirtualNwServiceRef" - schema: - $ref: "#/definitions/tapi.virtual.network.VirtualNwServiceRef" 400: description: "Internal error" - /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint={local-id}/latency-characteristic/: + 204: + description: "Object deleted" + /data/context/virtual-network-context/virtual-nw-service={uuid}/end-point={local-id}/name/: post: tags: - "tapi-virtual-network" - description: "creates tapi.topology.LatencyCharacteristic" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -5843,15 +3497,15 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of vnw-constraint" + description: "Id of end-point" required: true type: "string" - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" required: false schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -5859,11 +3513,14 @@ paths: description: "Internal error" 409: description: "Object already exists" - ? /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint={local-id}/latency-characteristic={traffic-property-name}/ - : get: + /data/context/virtual-network-context/virtual-nw-service={uuid}/end-point={local-id}/name={value-name}/: + get: tags: - "tapi-virtual-network" - description: "returns tapi.topology.LatencyCharacteristic" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -5872,25 +3529,28 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of vnw-constraint" + description: "Id of end-point" required: true type: "string" - - name: "traffic-property-name" + - name: "value-name" in: "path" - description: "Id of latency-characteristic" + description: "Id of name" required: true type: "string" responses: 200: - description: "tapi.topology.LatencyCharacteristic" + description: "tapi.common.NameAndValue" schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: + put: tags: - "tapi-virtual-network" - description: "creates tapi.topology.LatencyCharacteristic" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -5899,31 +3559,34 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of vnw-constraint" + description: "Id of end-point" required: true type: "string" - - name: "traffic-property-name" + - name: "value-name" in: "path" - description: "Id of latency-characteristic" + description: "Id of name" required: true type: "string" - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + 204: + description: "Object modified" + delete: tags: - "tapi-virtual-network" - description: "creates or updates tapi.topology.LatencyCharacteristic" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -5932,31 +3595,25 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of vnw-constraint" + description: "Id of end-point" required: true type: "string" - - name: "traffic-property-name" + - name: "value-name" in: "path" - description: "Id of latency-characteristic" + description: "Id of name" required: true type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" responses: - 201: - description: "Object created" 400: description: "Internal error" 204: - description: "Object modified" - delete: + description: "Object deleted" + /data/context/virtual-network-context/virtual-nw-service={uuid}/end-point={local-id}/service-interface-point/: + get: tags: - "tapi-virtual-network" - description: "removes tapi.topology.LatencyCharacteristic" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -5965,35 +3622,30 @@ paths: type: "string" - name: "local-id" in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" + description: "Id of end-point" required: true type: "string" responses: + 200: + description: "tapi.common.ServiceInterfacePointRef" + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" 400: description: "Internal error" - 204: - description: "Object deleted" - /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint={local-id}/name/: + /data/context/virtual-network-context/virtual-nw-service={uuid}/name/: post: tags: - "tapi-virtual-network" - description: "creates tapi.common.NameAndValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of virtual-nw-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - in: "body" name: "tapi.common.NameAndValue.body-param" description: "tapi.common.NameAndValue to be added to list" @@ -6007,22 +3659,20 @@ paths: description: "Internal error" 409: description: "Object already exists" - /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint={local-id}/name={value-name}/: + /data/context/virtual-network-context/virtual-nw-service={uuid}/name={value-name}/: get: tags: - "tapi-virtual-network" - description: "returns tapi.common.NameAndValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of virtual-nw-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - name: "value-name" in: "path" description: "Id of name" @@ -6035,21 +3685,19 @@ paths: $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - post: + put: tags: - "tapi-virtual-network" - description: "creates tapi.common.NameAndValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of virtual-nw-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - name: "value-name" in: "path" description: "Id of name" @@ -6057,7 +3705,7 @@ paths: type: "string" - in: "body" name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: $ref: "#/definitions/tapi.common.NameAndValue" @@ -6066,59 +3714,107 @@ paths: description: "Object created" 400: description: "Internal error" - 409: - description: "Object already exists" - put: + 204: + description: "Object modified" + delete: tags: - "tapi-virtual-network" - description: "creates or updates tapi.common.NameAndValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" description: "Id of virtual-nw-service" required: true type: "string" - - name: "local-id" + - name: "value-name" in: "path" - description: "Id of vnw-constraint" + description: "Id of name" required: true type: "string" - - name: "value-name" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/virtual-network-context/virtual-nw-service={uuid}/schedule/: + get: + tags: + - "tapi-virtual-network" + summary: "returns tapi.common.TimeRange" + description: "none" + parameters: + - name: "uuid" in: "path" - description: "Id of name" + description: "Id of virtual-nw-service" + required: true + type: "string" + responses: + 200: + description: "tapi.common.TimeRange" + schema: + $ref: "#/definitions/tapi.common.TimeRange" + 400: + description: "Internal error" + post: + tags: + - "tapi-virtual-network" + summary: "creates tapi.common.TimeRange" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of virtual-nw-service" required: true type: "string" - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" + name: "tapi.common.TimeRange.body-param" + description: "tapi.common.TimeRange to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.NameAndValue" + $ref: "#/definitions/tapi.common.TimeRange" responses: 201: description: "Object created" 400: description: "Internal error" - 204: - description: "Object modified" - delete: + 409: + description: "Object already exists" + put: tags: - "tapi-virtual-network" - description: "removes tapi.common.NameAndValue" + summary: "creates or updates tapi.common.TimeRange" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of virtual-nw-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - - name: "value-name" + - in: "body" + name: "tapi.common.TimeRange.body-param" + description: "tapi.common.TimeRange to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.TimeRange" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-virtual-network" + summary: "removes tapi.common.TimeRange" + description: "none" + parameters: + - name: "uuid" in: "path" - description: "Id of name" + description: "Id of virtual-nw-service" required: true type: "string" responses: @@ -6126,50 +3822,42 @@ paths: description: "Internal error" 204: description: "Object deleted" - /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint={local-id}/requested-capacity/: + /data/context/virtual-network-context/virtual-nw-service={uuid}/state/: get: tags: - "tapi-virtual-network" - description: "returns tapi.common.Capacity" + summary: "returns tapi.common.AdminStatePac" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of virtual-nw-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" responses: 200: - description: "tapi.common.Capacity" + description: "tapi.common.AdminStatePac" schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.common.AdminStatePac" 400: description: "Internal error" post: tags: - "tapi-virtual-network" - description: "creates tapi.common.Capacity" + summary: "creates tapi.common.AdminStatePac" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of virtual-nw-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - in: "body" - name: "tapi.common.Capacity.body-param" - description: "tapi.common.Capacity to be added to list" + name: "tapi.common.AdminStatePac.body-param" + description: "tapi.common.AdminStatePac to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.common.AdminStatePac" responses: 201: description: "Object created" @@ -6180,24 +3868,20 @@ paths: put: tags: - "tapi-virtual-network" - description: "creates or updates tapi.common.Capacity" + summary: "creates or updates tapi.common.AdminStatePac" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of virtual-nw-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - in: "body" - name: "tapi.common.Capacity.body-param" - description: "tapi.common.Capacity to be added or updated" + name: "tapi.common.AdminStatePac.body-param" + description: "tapi.common.AdminStatePac to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.Capacity" + $ref: "#/definitions/tapi.common.AdminStatePac" responses: 201: description: "Object created" @@ -6208,67 +3892,57 @@ paths: delete: tags: - "tapi-virtual-network" - description: "removes tapi.common.Capacity" + summary: "removes tapi.common.AdminStatePac" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of virtual-nw-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint={local-id}/requested-capacity/bandwidth-profile/: + /data/context/virtual-network-context/virtual-nw-service={uuid}/topology/: get: tags: - "tapi-virtual-network" - description: "returns tapi.common.BandwidthProfile" + summary: "returns tapi.topology.TopologyRef" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of virtual-nw-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" responses: 200: - description: "tapi.common.BandwidthProfile" + description: "tapi.topology.TopologyRef" schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.topology.TopologyRef" 400: description: "Internal error" + /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint/: post: tags: - "tapi-virtual-network" - description: "creates tapi.common.BandwidthProfile" + summary: "creates tapi.virtual.network.VirtualNetworkConstraint" + description: "none" parameters: - name: "uuid" in: "path" description: "Id of virtual-nw-service" required: true type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - in: "body" - name: "tapi.common.BandwidthProfile.body-param" - description: "tapi.common.BandwidthProfile to be added to list" + name: "tapi.virtual.network.VirtualNetworkConstraint.body-param" + description: "tapi.virtual.network.VirtualNetworkConstraint to be added to\ + \ list" required: false schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.virtual.network.VirtualNetworkConstraint" responses: 201: description: "Object created" @@ -6276,10 +3950,35 @@ paths: description: "Internal error" 409: description: "Object already exists" + /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint={local-id}/: + get: + tags: + - "tapi-virtual-network" + summary: "returns tapi.virtual.network.VirtualNetworkConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of virtual-nw-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of vnw-constraint" + required: true + type: "string" + responses: + 200: + description: "tapi.virtual.network.VirtualNetworkConstraint" + schema: + $ref: "#/definitions/tapi.virtual.network.VirtualNetworkConstraint" + 400: + description: "Internal error" put: tags: - "tapi-virtual-network" - description: "creates or updates tapi.common.BandwidthProfile" + summary: "creates or updates tapi.virtual.network.VirtualNetworkConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -6292,11 +3991,12 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.BandwidthProfile.body-param" - description: "tapi.common.BandwidthProfile to be added or updated" + name: "tapi.virtual.network.VirtualNetworkConstraint.body-param" + description: "tapi.virtual.network.VirtualNetworkConstraint to be added or\ + \ updated" required: false schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" + $ref: "#/definitions/tapi.virtual.network.VirtualNetworkConstraint" responses: 201: description: "Object created" @@ -6307,7 +4007,8 @@ paths: delete: tags: - "tapi-virtual-network" - description: "removes tapi.common.BandwidthProfile" + summary: "removes tapi.virtual.network.VirtualNetworkConstraint" + description: "none" parameters: - name: "uuid" in: "path" @@ -6324,11 +4025,13 @@ paths: description: "Internal error" 204: description: "Object deleted" - ? /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint={local-id}/requested-capacity/bandwidth-profile/committed-burst-size/ - : get: + /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint={local-id}/cost-characteristic/: + post: tags: - "tapi-virtual-network" - description: "returns tapi.common.CapacityValue" + summary: "creates tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" @@ -6340,17 +4043,26 @@ paths: description: "Id of vnw-constraint" required: true type: "string" + - in: "body" + name: "tapi.topology.CostCharacteristic.body-param" + description: "tapi.topology.CostCharacteristic to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint={local-id}/cost-characteristic={cost-name}/: + get: tags: - "tapi-virtual-network" - description: "creates tapi.common.CapacityValue" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" @@ -6362,23 +4074,24 @@ paths: description: "Id of vnw-constraint" required: true type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" responses: - 201: - description: "Object created" + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-virtual-network" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" @@ -6390,12 +4103,17 @@ paths: description: "Id of vnw-constraint" required: true type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.topology.CostCharacteristic.body-param" + description: "tapi.topology.CostCharacteristic to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.CostCharacteristic" responses: 201: description: "Object created" @@ -6406,7 +4124,9 @@ paths: delete: tags: - "tapi-virtual-network" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." parameters: - name: "uuid" in: "path" @@ -6418,16 +4138,22 @@ paths: description: "Id of vnw-constraint" required: true type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - ? /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint={local-id}/requested-capacity/bandwidth-profile/committed-information-rate/ + ? /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint={local-id}/diversity-exclusion={virtual-nw-service-uuid}/ : get: tags: - "tapi-virtual-network" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.virtual.network.VirtualNwServiceRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -6439,17 +4165,25 @@ paths: description: "Id of vnw-constraint" required: true type: "string" + - name: "virtual-nw-service-uuid" + in: "path" + description: "Id of diversity-exclusion" + required: true + type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.virtual.network.VirtualNwServiceRef" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.virtual.network.VirtualNwServiceRef" 400: description: "Internal error" + /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint={local-id}/latency-characteristic/: post: tags: - "tapi-virtual-network" - description: "creates tapi.common.CapacityValue" + summary: "creates tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" @@ -6462,11 +4196,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.topology.LatencyCharacteristic.body-param" + description: "tapi.topology.LatencyCharacteristic to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" responses: 201: description: "Object created" @@ -6474,10 +4208,42 @@ paths: description: "Internal error" 409: description: "Object already exists" + ? /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint={local-id}/latency-characteristic={traffic-property-name}/ + : get: + tags: + - "tapi-virtual-network" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of virtual-nw-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of vnw-constraint" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" put: tags: - "tapi-virtual-network" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" @@ -6489,12 +4255,17 @@ paths: description: "Id of vnw-constraint" required: true type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.topology.LatencyCharacteristic.body-param" + description: "tapi.topology.LatencyCharacteristic to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" responses: 201: description: "Object created" @@ -6505,7 +4276,9 @@ paths: delete: tags: - "tapi-virtual-network" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." parameters: - name: "uuid" in: "path" @@ -6517,16 +4290,24 @@ paths: description: "Id of vnw-constraint" required: true type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - ? /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint={local-id}/requested-capacity/bandwidth-profile/peak-burst-size/ - : get: + /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint={local-id}/name/: + post: tags: - "tapi-virtual-network" - description: "returns tapi.common.CapacityValue" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -6538,17 +4319,27 @@ paths: description: "Id of vnw-constraint" required: true type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" + 201: + description: "Object created" 400: description: "Internal error" - post: + 409: + description: "Object already exists" + /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint={local-id}/name={value-name}/: + get: tags: - "tapi-virtual-network" - description: "creates tapi.common.CapacityValue" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -6560,23 +4351,25 @@ paths: description: "Id of vnw-constraint" required: true type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" responses: - 201: - description: "Object created" + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" 400: description: "Internal error" - 409: - description: "Object already exists" put: tags: - "tapi-virtual-network" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -6588,12 +4381,17 @@ paths: description: "Id of vnw-constraint" required: true type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.NameAndValue" responses: 201: description: "Object created" @@ -6604,7 +4402,10 @@ paths: delete: tags: - "tapi-virtual-network" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." parameters: - name: "uuid" in: "path" @@ -6616,16 +4417,22 @@ paths: description: "Id of vnw-constraint" required: true type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" - ? /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint={local-id}/requested-capacity/bandwidth-profile/peak-information-rate/ - : get: + /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint={local-id}/requested-capacity/: + get: tags: - "tapi-virtual-network" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" @@ -6639,15 +4446,16 @@ paths: type: "string" responses: 200: - description: "tapi.common.CapacityValue" + description: "tapi.common.Capacity" schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" 400: description: "Internal error" post: tags: - "tapi-virtual-network" - description: "creates tapi.common.CapacityValue" + summary: "creates tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" @@ -6660,11 +4468,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" + name: "tapi.common.Capacity.body-param" + description: "tapi.common.Capacity to be added to list" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" responses: 201: description: "Object created" @@ -6675,7 +4483,8 @@ paths: put: tags: - "tapi-virtual-network" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" @@ -6688,11 +4497,11 @@ paths: required: true type: "string" - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" + name: "tapi.common.Capacity.body-param" + description: "tapi.common.Capacity to be added or updated" required: false schema: - $ref: "#/definitions/tapi.common.CapacityValue" + $ref: "#/definitions/tapi.common.Capacity" responses: 201: description: "Object created" @@ -6703,7 +4512,8 @@ paths: delete: tags: - "tapi-virtual-network" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.common.Capacity" + description: "none" parameters: - name: "uuid" in: "path" @@ -6724,7 +4534,9 @@ paths: get: tags: - "tapi-virtual-network" - description: "returns tapi.common.CapacityValue" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -6746,7 +4558,9 @@ paths: post: tags: - "tapi-virtual-network" - description: "creates tapi.common.CapacityValue" + summary: "creates tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -6774,7 +4588,9 @@ paths: put: tags: - "tapi-virtual-network" - description: "creates or updates tapi.common.CapacityValue" + summary: "creates or updates tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -6802,7 +4618,9 @@ paths: delete: tags: - "tapi-virtual-network" - description: "removes tapi.common.CapacityValue" + summary: "removes tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." parameters: - name: "uuid" in: "path" @@ -6823,7 +4641,8 @@ paths: get: tags: - "tapi-virtual-network" - description: "returns tapi.common.ServiceInterfacePointRef" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -6846,7 +4665,8 @@ paths: get: tags: - "tapi-virtual-network" - description: "returns tapi.common.ServiceInterfacePointRef" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "none" parameters: - name: "uuid" in: "path" @@ -6869,6 +4689,8 @@ paths: post: tags: - "tapi-notification" + summary: "operates on tapi.notification.CreateNotificationSubscriptionService" + description: "operates on tapi.notification.CreateNotificationSubscriptionService" parameters: - in: "body" name: "tapi.notification.createnotificationsubscriptionservice.Input.body-param" @@ -6890,6 +4712,8 @@ paths: post: tags: - "tapi-virtual-network" + summary: "operates on tapi.virtual.network.CreateVirtualNetworkService" + description: "operates on tapi.virtual.network.CreateVirtualNetworkService" parameters: - in: "body" name: "tapi.virtual.network.createvirtualnetworkservice.Input.body-param" @@ -6911,6 +4735,8 @@ paths: post: tags: - "tapi-notification" + summary: "operates on tapi.notification.DeleteNotificationSubscriptionService" + description: "operates on tapi.notification.DeleteNotificationSubscriptionService" parameters: - in: "body" name: "tapi.notification.deletenotificationsubscriptionservice.Input.body-param" @@ -6920,10 +4746,6 @@ paths: input: $ref: "#/definitions/tapi.notification.deletenotificationsubscriptionservice.Input" responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.DeleteNotificationSubscriptionService" 201: description: "No response" 400: @@ -6932,6 +4754,8 @@ paths: post: tags: - "tapi-virtual-network" + summary: "operates on tapi.virtual.network.DeleteVirtualNetworkService" + description: "operates on tapi.virtual.network.DeleteVirtualNetworkService" parameters: - in: "body" name: "tapi.virtual.network.deletevirtualnetworkservice.Input.body-param" @@ -6953,6 +4777,8 @@ paths: post: tags: - "tapi-topology" + summary: "operates on tapi.topology.GetLinkDetails" + description: "operates on tapi.topology.GetLinkDetails" parameters: - in: "body" name: "tapi.topology.getlinkdetails.Input.body-param" @@ -6974,6 +4800,8 @@ paths: post: tags: - "tapi-topology" + summary: "operates on tapi.topology.GetNodeDetails" + description: "operates on tapi.topology.GetNodeDetails" parameters: - in: "body" name: "tapi.topology.getnodedetails.Input.body-param" @@ -6995,6 +4823,8 @@ paths: post: tags: - "tapi-topology" + summary: "operates on tapi.topology.GetNodeEdgePointDetails" + description: "operates on tapi.topology.GetNodeEdgePointDetails" parameters: - in: "body" name: "tapi.topology.getnodeedgepointdetails.Input.body-param" @@ -7016,6 +4846,8 @@ paths: post: tags: - "tapi-notification" + summary: "operates on tapi.notification.GetNotificationList" + description: "operates on tapi.notification.GetNotificationList" parameters: - in: "body" name: "tapi.notification.getnotificationlist.Input.body-param" @@ -7037,6 +4869,8 @@ paths: post: tags: - "tapi-notification" + summary: "operates on tapi.notification.GetNotificationSubscriptionServiceDetails" + description: "operates on tapi.notification.GetNotificationSubscriptionServiceDetails" parameters: - in: "body" name: "tapi.notification.getnotificationsubscriptionservicedetails.Input.body-param" @@ -7072,6 +4906,8 @@ paths: post: tags: - "tapi-common" + summary: "operates on tapi.common.GetServiceInterfacePointDetails" + description: "operates on tapi.common.GetServiceInterfacePointDetails" parameters: - in: "body" name: "tapi.common.getserviceinterfacepointdetails.Input.body-param" @@ -7121,6 +4957,8 @@ paths: post: tags: - "tapi-topology" + summary: "operates on tapi.topology.GetTopologyDetails" + description: "operates on tapi.topology.GetTopologyDetails" parameters: - in: "body" name: "tapi.topology.gettopologydetails.Input.body-param" @@ -7156,6 +4994,8 @@ paths: post: tags: - "tapi-virtual-network" + summary: "operates on tapi.virtual.network.GetVirtualNetworkServiceDetails" + description: "operates on tapi.virtual.network.GetVirtualNetworkServiceDetails" parameters: - in: "body" name: "tapi.virtual.network.getvirtualnetworkservicedetails.Input.body-param" @@ -7191,6 +5031,8 @@ paths: post: tags: - "tapi-notification" + summary: "operates on tapi.notification.UpdateNotificationSubscriptionService" + description: "operates on tapi.notification.UpdateNotificationSubscriptionService" parameters: - in: "body" name: "tapi.notification.updatenotificationsubscriptionservice.Input.body-param" @@ -7212,6 +5054,8 @@ paths: post: tags: - "tapi-common" + summary: "operates on tapi.common.UpdateServiceInterfacePoint" + description: "operates on tapi.common.UpdateServiceInterfacePoint" parameters: - in: "body" name: "tapi.common.updateserviceinterfacepoint.Input.body-param" @@ -7243,45 +5087,9 @@ definitions: enum: - "LOCKED" - "UNLOCKED" - tapi.common.BandwidthProfile: - type: "object" - properties: - committed-information-rate: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - coupling-flag: - type: "boolean" - description: "none" - default: false - bw-profile-type: - description: "none" - $ref: "#/definitions/tapi.common.BandwidthProfileType" - peak-information-rate: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - committed-burst-size: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - peak-burst-size: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - color-aware: - type: "boolean" - description: "none" - default: false - tapi.common.BandwidthProfileType: - type: "string" - enum: - - "MEF_10.x" - - "RFC_2697" - - "RFC_2698" - - "RFC_4115" tapi.common.Capacity: type: "object" properties: - bandwidth-profile: - description: "none" - $ref: "#/definitions/tapi.common.BandwidthProfile" total-size: description: "Total capacity of the TopologicalEntity in MB/s. In case of\ \ bandwidthProfile, this is expected to same as the committedInformationRate." @@ -7322,9 +5130,9 @@ definitions: tapi.common.Context: allOf: - $ref: "#/definitions/tapi.common.TapiContext" - - $ref: "#/definitions/tapi.notification.ContextAugmentation1" + - $ref: "#/definitions/tapi.notification.ContextAugmentation2" - $ref: "#/definitions/tapi.topology.ContextAugmentation3" - - $ref: "#/definitions/tapi.virtual.network.ContextAugmentation2" + - $ref: "#/definitions/tapi.virtual.network.ContextAugmentation1" tapi.common.ForwardingDirection: type: "string" enum: @@ -7346,21 +5154,21 @@ definitions: properties: name: type: "array" - description: "List of names. A property of an entity with a value that is\ - \ unique in some namespace but may change during the life of the entity.\ - \ A name carries no semantics with respect to the purpose of the entity." + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." items: $ref: "#/definitions/tapi.common.NameAndValue" uuid: type: "string" description: "UUID: An identifier that is universally unique within an identifier\ - \ space, where the identifier space is itself globally unique, and immutable.\ - \ An UUID carries no semantics with respect to the purpose or state of the\ - \ entity.\r\n UUID here uses string representation as\ - \ defined in RFC 4122. The canonical representation uses lowercase characters.\r\ - \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ - \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ - \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a UUID\ + \ in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.common.LayerProtocolName: type: "string" enum: @@ -7381,9 +5189,9 @@ definitions: properties: name: type: "array" - description: "List of names. A property of an entity with a value that is\ - \ unique in some namespace but may change during the life of the entity.\ - \ A name carries no semantics with respect to the purpose of the entity." + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." items: $ref: "#/definitions/tapi.common.NameAndValue" local-id: @@ -7436,7 +5244,7 @@ definitions: $ref: "#/definitions/tapi.common.LayerProtocolName" description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ \ termination and adaptation functions of one or more transport layers. \r\ - \n The structure of LTP supports all transport protocols including\ + \n The structure of LTP supports all transport protocols including\ \ circuit and packet forms." tapi.common.ServiceInterfacePointRef: type: "object" @@ -7470,11 +5278,11 @@ definitions: type: "object" properties: termination-direction: - description: "The overall directionality of the LP. \r\n \ - \ - A BIDIRECTIONAL LP will have some SINK and/or SOURCE flowss.\r\n \ - \ - A SINK LP can only contain elements with SINK flows\ - \ or CONTRA_DIRECTION_SOURCE flows\r\n - A SOURCE LP\ - \ can only contain SOURCE flows or CONTRA_DIRECTION_SINK flows" + description: "The overall directionality of the LP. \r\n -\ + \ A BIDIRECTIONAL LP will have some SINK and/or SOURCE flowss.\r\n \ + \ - A SINK LP can only contain elements with SINK flows or CONTRA_DIRECTION_SOURCE\ + \ flows\r\n - A SOURCE LP can only contain SOURCE flows or\ + \ CONTRA_DIRECTION_SINK flows" $ref: "#/definitions/tapi.common.TerminationDirection" termination-state: description: "Indicates whether the layer is terminated and if so how." @@ -7489,12 +5297,28 @@ definitions: - "TERMINATED_BIDIRECTIONAL" - "LT_PERMENANTLY_TERMINATED" - "TERMINATION_STATE_UNKNOWN" - tapi.common.getserviceinterfacepointdetails.Input: + tapi.common.TimeRange: type: "object" properties: - sip-id-or-name: + end-time: + type: "string" + description: "none" + start-time: type: "string" description: "none" + tapi.common.getserviceinterfacepointdetails.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.common.getserviceinterfacepointdetails.Output: type: "object" properties: @@ -7512,29 +5336,20 @@ definitions: tapi.common.updateserviceinterfacepoint.Input: type: "object" properties: - sip-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" state: description: "none" $ref: "#/definitions/tapi.common.AdministrativeState" - tapi.notification.AlarmInfo: - type: "object" - properties: - perceived-severity: - description: "none" - $ref: "#/definitions/tapi.notification.PerceivedSeverityType" - probable-cause: - type: "string" - description: "none" - service-affecting: - description: "none" - $ref: "#/definitions/tapi.notification.ServiceAffecting" - is-transient: - type: "boolean" - description: "none" - default: false - tapi.notification.ContextAugmentation1: + tapi.notification.ContextAugmentation2: type: "object" properties: notification-context: @@ -7548,11 +5363,6 @@ definitions: properties: output: $ref: "#/definitions/tapi.notification.createnotificationsubscriptionservice.Output" - tapi.notification.DeleteNotificationSubscriptionService: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.notification.deletenotificationsubscriptionservice.Output" tapi.notification.GetNotificationList: type: "object" properties: @@ -7591,8 +5401,8 @@ definitions: - type: "object" properties: target-object-type: + type: "string" description: "none" - $ref: "#/definitions/tapi.notification.ObjectType" additional-text: type: "string" description: "none" @@ -7608,18 +5418,15 @@ definitions: type: "integer" format: "int32" description: "A monotonous increasing sequence number associated with the\ - \ notification.\r\n The exact semantics of how this\ - \ sequence number is assigned (per channel or subscription or source or\ - \ system) is left undefined." - tca-info: - description: "none" - $ref: "#/definitions/tapi.notification.TcaInfo" + \ notification.\r\n The exact semantics of how this sequence\ + \ number is assigned (per channel or subscription or source or system)\ + \ is left undefined." target-object-identifier: type: "string" description: "none" notification-type: + type: "string" description: "none" - $ref: "#/definitions/tapi.notification.NotificationType" target-object-name: type: "array" description: "none" @@ -7631,9 +5438,9 @@ definitions: source-indicator: description: "none" $ref: "#/definitions/tapi.notification.SourceIndicator" - alarm-info: + layer-protocol-qualifier: + type: "string" description: "none" - $ref: "#/definitions/tapi.notification.AlarmInfo" changed-attributes: type: "array" description: "none" @@ -7653,9 +5460,9 @@ definitions: stream-address: type: "string" description: "The address/location/URI of the channel/stream to which the\ - \ subscribed notifications are published.\r\n This\ - \ specifics of this is typically dependent on the implementation protocol\ - \ & mechanism and hence is typed as a string." + \ subscribed notifications are published.\r\n This specifics\ + \ of this is typically dependent on the implementation protocol & mechanism\ + \ and hence is typed as a string." description: "none" tapi.notification.NotificationContext: type: "object" @@ -7690,68 +5497,16 @@ definitions: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.ObjectType" + type: "string" supported-notification-types: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.NotificationType" + type: "string" subscription-filter: description: "none" $ref: "#/definitions/tapi.notification.SubscriptionFilter" description: "none" - tapi.notification.NotificationType: - type: "string" - enum: - - "OBJECT_CREATION" - - "OBJECT_DELETION" - - "ATTRIBUTE_VALUE_CHANGE" - - "ALARM_EVENT" - - "THRESHOLD_CROSSING_ALERT" - tapi.notification.ObjectType: - type: "string" - enum: - - "TOPOLOGY" - - "NODE" - - "LINK" - - "CONNECTION" - - "PATH" - - "CONNECTIVITY_SERVICE" - - "VIRTUAL_NETWORK_SERVICE" - - "PATH_COMPUTATION_SERVICE" - - "NODE_EDGE_POINT" - - "SERVICE_INTERFACE_POINT" - - "CONNECTION_END_POINT" - - "MAINTENANCE_ENTITY_GROUP" - - "MAINTENANCE_ENTITY" - - "MEG_END_POINT" - - "MEG_INTERMEDIATE_POINT" - - "SWITCH_CONTROL" - - "SWITCH" - - "ROUTE" - - "NODE_RULE_GROUP" - - "INTER_RULE_GROUP" - - "RULE" - - "OAM_JOB" - tapi.notification.PerceivedSeverityType: - type: "string" - enum: - - "CRITICAL" - - "MAJOR" - - "MINOR" - - "WARNING" - - "CLEARED" - tapi.notification.PerceivedTcaSeverity: - type: "string" - enum: - - "WARNING" - - "CLEAR" - tapi.notification.ServiceAffecting: - type: "string" - enum: - - "SERVICE_AFFECTING" - - "NOT_SERVICE_AFFECTING" - - "UNKNOWN" tapi.notification.SourceIndicator: type: "string" enum: @@ -7767,7 +5522,7 @@ definitions: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.NotificationType" + type: "string" requested-object-identifier: type: "array" description: "none" @@ -7788,46 +5543,13 @@ definitions: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.ObjectType" + type: "string" description: "none" tapi.notification.SubscriptionState: type: "string" enum: - "SUSPENDED" - "ACTIVE" - tapi.notification.TcaInfo: - type: "object" - properties: - threshold-crossing: - description: "none" - $ref: "#/definitions/tapi.notification.ThresholdCrossingType" - threshold-parameter: - type: "string" - description: "none" - is-transient: - type: "boolean" - description: "none" - default: false - threshold-value: - type: "integer" - format: "int32" - description: "none" - perceived-severity: - description: "none" - $ref: "#/definitions/tapi.notification.PerceivedTcaSeverity" - suspect-interval-flag: - type: "boolean" - description: "none" - default: false - measurement-interval: - type: "string" - description: "none" - tapi.notification.ThresholdCrossingType: - type: "string" - enum: - - "THRESHOLD_ABOVE" - - "THRESHOLD_BELOW" - - "CLEARED" tapi.notification.UpdateNotificationSubscriptionService: type: "object" properties: @@ -7839,6 +5561,23 @@ definitions: subscription-state: description: "none" $ref: "#/definitions/tapi.notification.SubscriptionState" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" subscription-filter: description: "none" $ref: "#/definitions/tapi.notification.SubscriptionFilter" @@ -7851,24 +5590,33 @@ definitions: tapi.notification.deletenotificationsubscriptionservice.Input: type: "object" properties: - subscription-id-or-name: + uuid: type: "string" - description: "none" - tapi.notification.deletenotificationsubscriptionservice.Output: - type: "object" - properties: - subscription-service: - description: "none" - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.notification.getnotificationlist.Input: type: "object" properties: - time-period: - type: "string" - description: "none" - subscription-id-or-name: - type: "string" + time-range: description: "none" + $ref: "#/definitions/tapi.common.TimeRange" + subscription-id: + type: "string" + description: "UUID of the associated Notification Subscription Service: An\ + \ identifier that is universally unique within an identifier space, where\ + \ the identifier space is itself globally unique, and immutable.\r\n \ + \ An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.notification.getnotificationlist.Output: type: "object" properties: @@ -7880,9 +5628,16 @@ definitions: tapi.notification.getnotificationsubscriptionservicedetails.Input: type: "object" properties: - subscription-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.notification.getnotificationsubscriptionservicedetails.Output: type: "object" properties: @@ -7904,24 +5659,38 @@ definitions: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.ObjectType" + type: "string" supported-notification-types: type: "array" description: "none" items: - $ref: "#/definitions/tapi.notification.NotificationType" + type: "string" tapi.notification.updatenotificationsubscriptionservice.Input: type: "object" properties: subscription-state: description: "none" $ref: "#/definitions/tapi.notification.SubscriptionState" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" subscription-filter: description: "none" $ref: "#/definitions/tapi.notification.SubscriptionFilter" - subscription-id-or-name: - type: "string" - description: "none" tapi.notification.updatenotificationsubscriptionservice.Output: type: "object" properties: @@ -8014,7 +5783,7 @@ definitions: type: "string" description: "High frequency deviation from true periodicity of a signal and\ \ therefore a small high rate of change of transfer latency.\r\n \ - \ Applies to TDM systems (and not packet)." + \ Applies to TDM systems (and not packet)." fixed-latency-characteristic: type: "string" description: "A TopologicalEntity suffers delay caused by the realization\ @@ -8025,7 +5794,7 @@ definitions: type: "string" description: "Low frequency deviation from true periodicity of a signal and\ \ therefore a small low rate of change of transfer latency.\r\n \ - \ Applies to TDM systems (and not packet)." + \ Applies to TDM systems (and not packet)." queing-latency-characteristic: type: "string" description: "The specific queuing latency for the traffic property." @@ -8057,22 +5826,35 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.common.LayerProtocolName" - resilience-type: + restoration-policy: description: "none" - $ref: "#/definitions/tapi.topology.ResilienceType" + $ref: "#/definitions/tapi.topology.RestorationPolicy" node-edge-point: type: "array" description: "none" items: $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + protection-type: + description: "none" + $ref: "#/definitions/tapi.topology.ProtectionType" direction: - description: "The directionality of the Link. \r\n Is\ - \ applicable to simple Links where all LinkEnds are BIDIRECTIONAL (the\ - \ Link will be BIDIRECTIONAL) or UNIDIRECTIONAL (the Link will be UNIDIRECTIONAL).\ - \ \r\n Is not present in more complex cases." + description: "The directionality of the Link. \r\n Is applicable\ + \ to simple Links where all LinkEnds are BIDIRECTIONAL (the Link will\ + \ be BIDIRECTIONAL) or UNIDIRECTIONAL (the Link will be UNIDIRECTIONAL).\ + \ \r\n Is not present in more complex cases." $ref: "#/definitions/tapi.common.ForwardingDirection" description: "The Link object class models effective adjacency between two or\ \ more ForwardingDomains (FD). " + tapi.topology.NepLayerProtocolCapability: + type: "object" + properties: + layer-protocol-qualifier: + type: "string" + description: "none" + number-of-cep-instances: + type: "integer" + format: "int32" + description: "none" tapi.topology.NetworkTopologyService: allOf: - $ref: "#/definitions/tapi.common.GlobalClass" @@ -8102,16 +5884,16 @@ definitions: encap-topology: description: "none" $ref: "#/definitions/tapi.topology.TopologyRef" - owned-node-edge-point: + node-rule-group: type: "array" description: "none" items: - $ref: "#/definitions/tapi.topology.NodeEdgePoint" - node-rule-group: + $ref: "#/definitions/tapi.topology.NodeRuleGroup" + node-edge-point: type: "array" description: "none" items: - $ref: "#/definitions/tapi.topology.NodeRuleGroup" + $ref: "#/definitions/tapi.topology.NodeEdgePoint" aggregated-node-edge-point: type: "array" description: "none" @@ -8120,8 +5902,8 @@ definitions: description: "The ForwardingDomain (FD) object class models the ForwardingDomain\ \ topological component which is used to effect forwarding of transport characteristic\ \ information and offers the potential to enable forwarding. \r\n \ - \ At the lowest level of recursion, an FD (within a network element\ - \ (NE)) represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ + \ At the lowest level of recursion, an FD (within a network element (NE))\ + \ represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ \ multiple switch matrices (FDs). " tapi.topology.NodeEdgePoint: allOf: @@ -8143,6 +5925,11 @@ definitions: \ balancing/Resilience) should be considered experimental" items: $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + available-cep-layer-protocol: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NepLayerProtocolCapability" aggregated-node-edge-point: type: "array" description: "none" @@ -8154,14 +5941,9 @@ definitions: link-port-direction: description: "The orientation of defined flow at the LinkEnd." $ref: "#/definitions/tapi.common.PortDirection" - supported-cep-layer-protocol-qualifier: - type: "array" - description: "none" - items: - type: "string" description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ \ termination and adaptation functions of one or more transport layers. \r\ - \n The structure of LTP supports all transport protocols including\ + \n The structure of LTP supports all transport protocols including\ \ circuit and packet forms." tapi.topology.NodeEdgePointRef: allOf: @@ -8171,7 +5953,7 @@ definitions: node-edge-point-uuid: type: "string" description: "none" - x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:owned-node-edge-point/tapi-topology:uuid" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:node-edge-point/tapi-topology:uuid" description: "none" tapi.topology.NodeRef: allOf: @@ -8226,41 +6008,32 @@ definitions: tapi.topology.ProtectionType: type: "string" enum: - - "NO_PROTECTON" + - "NO_PROTECTION" - "ONE_PLUS_ONE_PROTECTION" - - "ONE_PLUS_ONE_PROTECTION_WITH_DYNAMIC_RESTORATION" - - "PERMANENT_ONE_PLUS_ONE_PROTECTION" - "ONE_FOR_ONE_PROTECTION" - - "DYNAMIC_RESTORATION" - - "PRE_COMPUTED_RESTORATION" - tapi.topology.ResilienceType: - type: "object" - properties: - restoration-policy: - description: "none" - $ref: "#/definitions/tapi.topology.RestorationPolicy" - protection-type: - description: "none" - $ref: "#/definitions/tapi.topology.ProtectionType" + - "ONE_FOR_N_PROTECTION" + - "M_FOR_N_PROTECTION" + - "ONE_FOR_ONE_BY_N" tapi.topology.RestorationPolicy: type: "string" enum: - "PER_DOMAIN_RESTORATION" - "END_TO_END_RESTORATION" - "NA" + - "DYNAMIC_RESTORATION" + - "PRE_COMPUTED_RESTORATION" tapi.topology.RiskCharacteristic: type: "object" properties: risk-characteristic-name: type: "string" description: "The name of the risk characteristic. The characteristic may\ - \ be related to a specific degree of closeness. \r\n \ - \ For example a particular characteristic may apply to failures that are\ - \ localized (e.g. to one side of a road) where as another characteristic\ - \ may relate to failures that have a broader impact (e.g. both sides of\ - \ a road that crosses a bridge).\r\n Depending upon the\ - \ importance of the traffic being routed different risk characteristics\ - \ will be evaluated." + \ be related to a specific degree of closeness. \r\n For\ + \ example a particular characteristic may apply to failures that are localized\ + \ (e.g. to one side of a road) where as another characteristic may relate\ + \ to failures that have a broader impact (e.g. both sides of a road that\ + \ crosses a bridge).\r\n Depending upon the importance of\ + \ the traffic being routed different risk characteristics will be evaluated." risk-identifier-list: type: "array" description: "A list of the identifiers of each physical/geographic unit (with\ @@ -8322,11 +6095,16 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.topology.Node" + boundary-node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" description: "The ForwardingDomain (FD) object class models the ForwardingDomain\ \ topological component which is used to effect forwarding of transport characteristic\ \ information and offers the potential to enable forwarding. \r\n \ - \ At the lowest level of recursion, an FD (within a network element\ - \ (NE)) represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ + \ At the lowest level of recursion, an FD (within a network element (NE))\ + \ represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ \ multiple switch matrices (FDs). " tapi.topology.TopologyContext: type: "object" @@ -8361,7 +6139,7 @@ definitions: error-characteristic: type: "string" description: "Describes the degree to which the signal propagated can be errored.\ - \ \r\n Applies to TDM systems as the errored signal will\ + \ \r\n Applies to TDM systems as the errored signal will\ \ be propagated and not packet as errored packets will be discarded." unavailable-time-characteristic: type: "string" @@ -8374,19 +6152,19 @@ definitions: delivery-order-characteristic: type: "string" description: "Describes the degree to which packets will be delivered out\ - \ of sequence.\r\n Does not apply to TDM as the TDM protocols\ + \ of sequence.\r\n Does not apply to TDM as the TDM protocols\ \ maintain strict order." repeat-delivery-characteristic: type: "string" description: "Primarily applies to packet systems where a packet may be delivered\ - \ more than once (in fault recovery for example). \r\n \ - \ It can also apply to TDM where several frames may be received twice\ - \ due to switching in a system with a large differential propagation delay." + \ more than once (in fault recovery for example). \r\n It\ + \ can also apply to TDM where several frames may be received twice due to\ + \ switching in a system with a large differential propagation delay." loss-characteristic: type: "string" description: "Describes the acceptable characteristic of lost packets where\ \ loss may result from discard due to errors or overflow.\r\n \ - \ Applies to packet systems and not TDM (as for TDM errored signals\ + \ Applies to packet systems and not TDM (as for TDM errored signals\ \ are propagated unless grossly errored and overflow/underflow turns into\ \ timing slips)." tapi.topology.TransferTimingPac: @@ -8423,12 +6201,27 @@ definitions: tapi.topology.getlinkdetails.Input: type: "object" properties: - link-id-or-name: - type: "string" - description: "none" - topology-id-or-name: + link-id: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.topology.getlinkdetails.Output: type: "object" properties: @@ -8438,12 +6231,27 @@ definitions: tapi.topology.getnodedetails.Input: type: "object" properties: - node-id-or-name: - type: "string" - description: "none" - topology-id-or-name: - type: "string" - description: "none" + node-id: + type: "string" + description: "UUID of the Node: An identifier that is universally unique within\ + \ an identifier space, where the identifier space is itself globally unique,\ + \ and immutable.\r\n An UUID carries no semantics with\ + \ respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC 4122. The canonical\ + \ representation uses lowercase characters.\r\n Pattern:\ + \ [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\ + \ \r\n Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.topology.getnodedetails.Output: type: "object" properties: @@ -8453,15 +6261,37 @@ definitions: tapi.topology.getnodeedgepointdetails.Input: type: "object" properties: - ep-id-or-name: - type: "string" - description: "none" - node-id-or-name: - type: "string" - description: "none" - topology-id-or-name: + node-id: + type: "string" + description: "UUID of the parent Node: An identifier that is universally unique\ + \ within an identifier space, where the identifier space is itself globally\ + \ unique, and immutable.\r\n An UUID carries no semantics\ + \ with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC 4122. The\ + \ canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\ + \ \r\n Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Node's Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + node-edge-point-id: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.topology.getnodeedgepointdetails.Output: type: "object" properties: @@ -8471,9 +6301,16 @@ definitions: tapi.topology.gettopologydetails.Input: type: "object" properties: - topology-id-or-name: + topology-id: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.topology.gettopologydetails.Output: type: "object" properties: @@ -8488,7 +6325,7 @@ definitions: description: "none" items: $ref: "#/definitions/tapi.topology.Topology" - tapi.virtual.network.ContextAugmentation2: + tapi.virtual.network.ContextAugmentation1: type: "object" properties: virtual-network-context: @@ -8573,8 +6410,8 @@ definitions: - type: "object" properties: schedule: - type: "string" description: "none" + $ref: "#/definitions/tapi.common.TimeRange" end-point: type: "array" description: "none" @@ -8598,9 +6435,8 @@ definitions: $ref: "#/definitions/tapi.virtual.network.VirtualNetworkConstraint" description: "The ForwardingConstruct (FC) object class models enabled potential\ \ for forwarding between two or more LTPs and like the LTP supports any transport\ - \ protocol including all circuit and packet forms.\r\n At the\ - \ lowest level of recursion, a FC represents a cross-connection within an\ - \ NE." + \ protocol including all circuit and packet forms.\r\n At the lowest\ + \ level of recursion, a FC represents a cross-connection within an NE." tapi.virtual.network.VirtualNetworkServiceEndPoint: allOf: - $ref: "#/definitions/tapi.common.LocalClass" @@ -8621,16 +6457,16 @@ definitions: description: "The orientation of defined flow at the EndPoint." $ref: "#/definitions/tapi.common.PortDirection" description: "The association of the FC to LTPs is made via EndPoints.\r\n \ - \ The EndPoint (EP) object class models the access to the FC\ - \ function. \r\n The traffic forwarding between the associated\ - \ EPs of the FC depends upon the type of FC and may be associated with FcSwitch\ - \ object instances. \r\n In cases where there is resilience\ - \ the EndPoint may convey the resilience role of the access to the FC. \r\n\ - \ It can represent a protected (resilient/reliable) point or\ - \ a protecting (unreliable working or protection) point.\r\n \ - \ The EP replaces the Protection Unit of a traditional protection model.\ - \ \r\n The ForwadingConstruct can be considered as a component\ - \ and the EndPoint as a Port on that component" + \ The EndPoint (EP) object class models the access to the FC function.\ + \ \r\n The traffic forwarding between the associated EPs of the\ + \ FC depends upon the type of FC and may be associated with FcSwitch object\ + \ instances. \r\n In cases where there is resilience the EndPoint\ + \ may convey the resilience role of the access to the FC. \r\n \ + \ It can represent a protected (resilient/reliable) point or a protecting\ + \ (unreliable working or protection) point.\r\n The EP replaces\ + \ the Protection Unit of a traditional protection model. \r\n The\ + \ ForwadingConstruct can be considered as a component and the EndPoint as\ + \ a Port on that component" tapi.virtual.network.VirtualNwServiceRef: type: "object" properties: @@ -8641,13 +6477,30 @@ definitions: tapi.virtual.network.createvirtualnetworkservice.Input: type: "object" properties: - conn-schedule: - type: "string" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + schedule: description: "none" + $ref: "#/definitions/tapi.common.TimeRange" vnw-constraint: description: "none" $ref: "#/definitions/tapi.virtual.network.VirtualNetworkConstraint" - sep: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + end-point: type: "array" description: "none" items: @@ -8661,9 +6514,16 @@ definitions: tapi.virtual.network.deletevirtualnetworkservice.Input: type: "object" properties: - service-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.virtual.network.deletevirtualnetworkservice.Output: type: "object" properties: @@ -8673,9 +6533,16 @@ definitions: tapi.virtual.network.getvirtualnetworkservicedetails.Input: type: "object" properties: - service-id-or-name: + uuid: type: "string" - description: "none" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.virtual.network.getvirtualnetworkservicedetails.Output: type: "object" properties: