# Copyright 2022-2023 ETSI TeraFlowSDN - TFS OSG (https://tfs.etsi.org/) # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. --- swagger: "2.0" info: description: "\r\n This module contains TAPI Notification Model definitions.\r\ \n Source: TapiNotification.uml\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 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 This module contains TAPI Connectivity Model\ \ definitions.\r\n Source: TapiConnectivity.uml\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 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 This module contains TAPI Topology Model\ \ definitions.\r\n Source: TapiTopology.uml\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 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 This module contains TAPI Common Model definitions.\r\ \n Source: TapiCommon.uml\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 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 This module contains TAPI Path Computation\ \ Model definitions.\r\n Source: TapiPathComputation.uml\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 Copyright (c) 2018 Open Networking Foundation\ \ (ONF). All rights reserved.\r\n License: This module is distributed under\ \ the Apache License 2.0." version: "2.1.3" title: "tapi-notification,tapi-connectivity,tapi-topology,tapi-common,tapi-path-computation\ \ API" host: "localhost:1234" consumes: - "application/yang-data+json" produces: - "application/yang-data+json" paths: /data/tapi-common:context/: get: tags: - "tapi-common" summary: "returns tapi.common.Context" description: "none" parameters: [] responses: 200: description: "tapi.common.Context" schema: $ref: "#/definitions/tapi.common.ContextWrapper" 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.ContextWrapper" 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.ContextWrapper" 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/tapi-common:context/name/: post: tags: - "tapi-common" summary: "creates tapi.common.NameAndValue" 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." 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.NameAndValueWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" /data/tapi-common:context/name={value-name}/: get: tags: - "tapi-common" summary: "returns tapi.common.NameAndValue" 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." 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.NameAndValueWrapper" 400: description: "Internal error" put: tags: - "tapi-common" summary: "creates or updates tapi.common.NameAndValue" 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." 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.NameAndValueWrapper" 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. 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." parameters: - name: "value-name" in: "path" description: "Id of name" required: true type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" /data/tapi-common: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.ServiceInterfacePointWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" /data/tapi-common: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.ServiceInterfacePointWrapper" 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.ServiceInterfacePointWrapper" 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/tapi-common: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.CapacityWrapper" 400: description: "Internal error" /data/tapi-common:context/service-interface-point={uuid}/available-capacity/bandwidth-profile/: get: tags: - "tapi-common" summary: "returns tapi.common.BandwidthProfile" description: "none" 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.BandwidthProfileWrapper" 400: description: "Internal error" /data/tapi-common:context/service-interface-point={uuid}/available-capacity/bandwidth-profile/committed-burst-size/: get: tags: - "tapi-common" summary: "returns tapi.common.CapacityValue" description: "none" 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.CapacityValueWrapper" 400: description: "Internal error" /data/tapi-common:context/service-interface-point={uuid}/available-capacity/bandwidth-profile/committed-information-rate/: get: tags: - "tapi-common" summary: "returns tapi.common.CapacityValue" description: "none" 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.CapacityValueWrapper" 400: description: "Internal error" /data/tapi-common:context/service-interface-point={uuid}/available-capacity/bandwidth-profile/peak-burst-size/: get: tags: - "tapi-common" summary: "returns tapi.common.CapacityValue" description: "none" 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.CapacityValueWrapper" 400: description: "Internal error" /data/tapi-common:context/service-interface-point={uuid}/available-capacity/bandwidth-profile/peak-information-rate/: get: tags: - "tapi-common" summary: "returns tapi.common.CapacityValue" description: "none" 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.CapacityValueWrapper" 400: description: "Internal error" /data/tapi-common: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.CapacityValueWrapper" 400: description: "Internal error" /data/tapi-common:context/service-interface-point={uuid}/name/: post: tags: - "tapi-common" summary: "creates tapi.common.NameAndValue" 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." 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.NameAndValueWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" /data/tapi-common:context/service-interface-point={uuid}/name={value-name}/: get: tags: - "tapi-common" summary: "returns tapi.common.NameAndValue" 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." 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.NameAndValueWrapper" 400: description: "Internal error" put: tags: - "tapi-common" summary: "creates or updates tapi.common.NameAndValue" 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." 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.NameAndValueWrapper" 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. 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." 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/tapi-common: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.CapacityWrapper" 400: description: "Internal error" /data/tapi-common:context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/: get: tags: - "tapi-common" summary: "returns tapi.common.BandwidthProfile" description: "none" 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.BandwidthProfileWrapper" 400: description: "Internal error" /data/tapi-common:context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/: get: tags: - "tapi-common" summary: "returns tapi.common.CapacityValue" description: "none" 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.CapacityValueWrapper" 400: description: "Internal error" /data/tapi-common:context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/: get: tags: - "tapi-common" summary: "returns tapi.common.CapacityValue" description: "none" 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.CapacityValueWrapper" 400: description: "Internal error" /data/tapi-common:context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: get: tags: - "tapi-common" summary: "returns tapi.common.CapacityValue" description: "none" 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.CapacityValueWrapper" 400: description: "Internal error" /data/tapi-common:context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/: get: tags: - "tapi-common" summary: "returns tapi.common.CapacityValue" description: "none" 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.CapacityValueWrapper" 400: description: "Internal error" /data/tapi-common: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.CapacityValueWrapper" 400: description: "Internal error" /data/tapi-common:context/tapi-connectivity:connectivity-context/: get: tags: - "tapi-connectivity" summary: "returns tapi.connectivity.ConnectivityContext" description: "Augments the base TAPI Context with ConnectivityService information" parameters: [] responses: 200: description: "tapi.connectivity.ConnectivityContext" schema: $ref: "#/definitions/tapi.connectivity.ConnectivityContextWrapper" 400: description: "Internal error" post: tags: - "tapi-connectivity" summary: "creates tapi.connectivity.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" required: false schema: $ref: "#/definitions/tapi.connectivity.ConnectivityContextWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" put: tags: - "tapi-connectivity" 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" description: "tapi.connectivity.ConnectivityContext to be added or updated" required: false schema: $ref: "#/definitions/tapi.connectivity.ConnectivityContextWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 204: description: "Object modified" delete: tags: - "tapi-connectivity" summary: "removes tapi.connectivity.ConnectivityContext" description: "Augments the base TAPI Context with ConnectivityService information" parameters: [] responses: 400: description: "Internal error" 204: description: "Object deleted" /data/tapi-common:context/tapi-connectivity:connectivity-context/connection={uuid}/: get: tags: - "tapi-connectivity" summary: "returns tapi.connectivity.Connection" description: "none" parameters: - name: "uuid" in: "path" description: "Id of connection" required: true type: "string" responses: 200: description: "tapi.connectivity.Connection" schema: $ref: "#/definitions/tapi.connectivity.ConnectionWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-connectivity:connectivity-context/connection={uuid}/connection-end-point={topology-uuid},{node-uuid},{node-edge-point-uuid},{connection-end-point-uuid}/ : get: tags: - "tapi-connectivity" summary: "returns tapi.connectivity.ConnectionEndPointRef" description: "none" parameters: - name: "uuid" in: "path" description: "Id of connection" 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.ConnectionEndPointRefWrapper" 400: description: "Internal error" /data/tapi-common:context/tapi-connectivity:connectivity-context/connection={uuid}/connection-spec-reference/: get: tags: - "tapi-connectivity" summary: "returns tapi.connectivity.ConnectionSpecReference" description: "Provides the reference to the spec that defines the connection\ \ type and cepRoles." parameters: - name: "uuid" in: "path" description: "Id of connection" required: true type: "string" responses: 200: description: "tapi.connectivity.ConnectionSpecReference" schema: $ref: "#/definitions/tapi.connectivity.ConnectionSpecReferenceWrapper" 400: description: "Internal error" /data/tapi-common:context/tapi-connectivity:connectivity-context/connection={uuid}/lower-connection={connection-uuid}/: get: tags: - "tapi-connectivity" 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" description: "Id of connection" required: true type: "string" - name: "connection-uuid" in: "path" description: "Id of lower-connection" required: true type: "string" responses: 200: description: "tapi.connectivity.ConnectionRef" schema: $ref: "#/definitions/tapi.connectivity.ConnectionRefWrapper" 400: description: "Internal error" /data/tapi-common:context/tapi-connectivity:connectivity-context/connection={uuid}/name={value-name}/: get: tags: - "tapi-connectivity" summary: "returns tapi.common.NameAndValue" 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." parameters: - name: "uuid" in: "path" description: "Id of connection" 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.NameAndValueWrapper" 400: description: "Internal error" /data/tapi-common:context/tapi-connectivity:connectivity-context/connection={uuid}/route={local-id}/: get: tags: - "tapi-connectivity" summary: "returns tapi.connectivity.Route" description: "none" parameters: - name: "uuid" in: "path" description: "Id of connection" required: true type: "string" - name: "local-id" in: "path" description: "Id of route" required: true type: "string" responses: 200: description: "tapi.connectivity.Route" schema: $ref: "#/definitions/tapi.connectivity.RouteWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-connectivity:connectivity-context/connection={uuid}/route={local-id}/connection-end-point={topology-uuid},{node-uuid},{node-edge-point-uuid},{connection-end-point-uuid}/ : get: tags: - "tapi-connectivity" summary: "returns tapi.connectivity.ConnectionEndPointRef" description: "none" parameters: - name: "uuid" in: "path" description: "Id of connection" required: true type: "string" - name: "local-id" in: "path" description: "Id of route" 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.ConnectionEndPointRefWrapper" 400: description: "Internal error" /data/tapi-common:context/tapi-connectivity:connectivity-context/connection={uuid}/route={local-id}/name={value-name}/: get: tags: - "tapi-connectivity" summary: "returns tapi.common.NameAndValue" 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." parameters: - name: "uuid" in: "path" description: "Id of connection" required: true type: "string" - name: "local-id" in: "path" description: "Id of route" 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.NameAndValueWrapper" 400: description: "Internal error" /data/tapi-common:context/tapi-connectivity:connectivity-context/connection={uuid}/route={local-id}/resilience-route-pac/: get: tags: - "tapi-connectivity" summary: "returns tapi.connectivity.ResilienceRoute" description: "Provides optional resilience and state attributes to the Route." parameters: - name: "uuid" in: "path" description: "Id of connection" required: true type: "string" - name: "local-id" in: "path" description: "Id of route" required: true type: "string" responses: 200: description: "tapi.connectivity.ResilienceRoute" schema: $ref: "#/definitions/tapi.connectivity.ResilienceRouteWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-connectivity:connectivity-context/connection={uuid}/route={local-id}/resilience-route-pac/name={value-name}/ : get: tags: - "tapi-connectivity" summary: "returns tapi.common.NameAndValue" 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." parameters: - name: "uuid" in: "path" description: "Id of connection" required: true type: "string" - name: "local-id" in: "path" description: "Id of route" 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.NameAndValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-connectivity:connectivity-context/connection={uuid}/supported-client-link={topology-uuid},{link-uuid}/ : get: tags: - "tapi-connectivity" summary: "returns tapi.topology.LinkRef" description: "none" parameters: - name: "uuid" in: "path" description: "Id of connection" required: true type: "string" - name: "topology-uuid" in: "path" description: "Id of supported-client-link" required: true type: "string" - name: "link-uuid" in: "path" description: "Id of supported-client-link" required: true type: "string" responses: 200: description: "tapi.topology.LinkRef" schema: $ref: "#/definitions/tapi.topology.LinkRefWrapper" 400: description: "Internal error" /data/tapi-common:context/tapi-connectivity:connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/: get: tags: - "tapi-connectivity" summary: "returns tapi.connectivity.SwitchControl" description: "none" 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.connectivity.SwitchControl" schema: $ref: "#/definitions/tapi.connectivity.SwitchControlWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-connectivity:connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/name={value-name}/ : get: tags: - "tapi-connectivity" summary: "returns tapi.common.NameAndValue" 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." 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" - name: "value-name" in: "path" description: "Id of name" required: true type: "string" responses: 200: description: "tapi.common.NameAndValue" schema: $ref: "#/definitions/tapi.common.NameAndValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-connectivity:connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/resilience-type/ : get: tags: - "tapi-connectivity" summary: "returns tapi.topology.ResilienceType" description: "none" 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.ResilienceTypeWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-connectivity:connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/sub-switch-control={connection-uuid},{sub-switch-control-switch-control-uuid}/ : get: tags: - "tapi-connectivity" summary: "returns tapi.connectivity.SwitchControlRef" description: "none" 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" - name: "connection-uuid" in: "path" description: "Id of sub-switch-control" required: true type: "string" - name: "sub-switch-control-switch-control-uuid" in: "path" description: "Id of sub-switch-control" required: true type: "string" responses: 200: description: "tapi.connectivity.SwitchControlRef" schema: $ref: "#/definitions/tapi.connectivity.SwitchControlRefWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-connectivity:connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/switch={local-id}/ : get: tags: - "tapi-connectivity" summary: "returns tapi.connectivity.Switch" description: "none" 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" - name: "local-id" in: "path" description: "Id of switch" required: true type: "string" responses: 200: description: "tapi.connectivity.Switch" schema: $ref: "#/definitions/tapi.connectivity.SwitchWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-connectivity:connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/switch={local-id}/name={value-name}/ : get: tags: - "tapi-connectivity" summary: "returns tapi.common.NameAndValue" 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." 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" - name: "local-id" in: "path" description: "Id of switch" 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.NameAndValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-connectivity:connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/switch={local-id}/selected-connection-end-point={topology-uuid},{node-uuid},{node-edge-point-uuid},{connection-end-point-uuid}/ : get: tags: - "tapi-connectivity" summary: "returns tapi.connectivity.ConnectionEndPointRef" description: "none" 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" - name: "local-id" in: "path" description: "Id of switch" required: true type: "string" - name: "topology-uuid" in: "path" description: "Id of selected-connection-end-point" required: true type: "string" - name: "node-uuid" in: "path" description: "Id of selected-connection-end-point" required: true type: "string" - name: "node-edge-point-uuid" in: "path" description: "Id of selected-connection-end-point" required: true type: "string" - name: "connection-end-point-uuid" in: "path" description: "Id of selected-connection-end-point" required: true type: "string" responses: 200: description: "tapi.connectivity.ConnectionEndPointRef" schema: $ref: "#/definitions/tapi.connectivity.ConnectionEndPointRefWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-connectivity:connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/switch={local-id}/selected-route={connection-uuid},{route-local-id}/ : get: tags: - "tapi-connectivity" summary: "returns tapi.connectivity.RouteRef" description: "none" 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" - name: "local-id" in: "path" description: "Id of switch" required: true type: "string" - name: "connection-uuid" in: "path" description: "Id of selected-route" required: true type: "string" - name: "route-local-id" in: "path" description: "Id of selected-route" required: true type: "string" responses: 200: description: "tapi.connectivity.RouteRef" schema: $ref: "#/definitions/tapi.connectivity.RouteRefWrapper" 400: description: "Internal error" /data/tapi-common:context/tapi-connectivity:connectivity-context/connectivity-service/: post: tags: - "tapi-connectivity" summary: "creates tapi.connectivity.ConnectivityService" description: "none" parameters: - in: "body" name: "tapi.connectivity.ConnectivityService.body-param" description: "tapi.connectivity.ConnectivityService to be added to list" required: false schema: $ref: "#/definitions/tapi.connectivity.ConnectivityServiceWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" /data/tapi-common:context/tapi-connectivity:connectivity-context/connectivity-service={uuid}/: get: tags: - "tapi-connectivity" summary: "returns tapi.connectivity.ConnectivityService" description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" responses: 200: description: "tapi.connectivity.ConnectivityService" schema: $ref: "#/definitions/tapi.connectivity.ConnectivityServiceWrapper" 400: description: "Internal error" put: tags: - "tapi-connectivity" summary: "creates or updates tapi.connectivity.ConnectivityService" description: "none" 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 or updated" required: false schema: $ref: "#/definitions/tapi.connectivity.ConnectivityServiceWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 204: description: "Object modified" delete: tags: - "tapi-connectivity" summary: "removes tapi.connectivity.ConnectivityService" 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/tapi-common:context/tapi-connectivity:connectivity-context/connectivity-service={uuid}/connection={connection-uuid}/: get: tags: - "tapi-connectivity" summary: "returns tapi.connectivity.ConnectionRef" description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - name: "connection-uuid" in: "path" description: "Id of connection" required: true type: "string" responses: 200: description: "tapi.connectivity.ConnectionRef" schema: $ref: "#/definitions/tapi.connectivity.ConnectionRefWrapper" 400: description: "Internal error" /data/tapi-common:context/tapi-connectivity:connectivity-context/connectivity-service={uuid}/coroute-inclusion/: get: tags: - "tapi-connectivity" summary: "returns tapi.connectivity.ConnectivityServiceRef" description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" responses: 200: description: "tapi.connectivity.ConnectivityServiceRef" schema: $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRefWrapper" 400: description: "Internal error" post: tags: - "tapi-connectivity" summary: "creates tapi.connectivity.ConnectivityServiceRef" description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" 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.ConnectivityServiceRefWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" put: tags: - "tapi-connectivity" summary: "creates or updates tapi.connectivity.ConnectivityServiceRef" description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" 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.ConnectivityServiceRefWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 204: description: "Object modified" delete: tags: - "tapi-connectivity" summary: "removes tapi.connectivity.ConnectivityServiceRef" 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/tapi-common:context/tapi-connectivity:connectivity-context/connectivity-service={uuid}/cost-characteristic/: post: tags: - "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.topology.CostCharacteristic.body-param" description: "tapi.topology.CostCharacteristic to be added to list" required: false schema: $ref: "#/definitions/tapi.topology.CostCharacteristicWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" /data/tapi-common:context/tapi-connectivity:connectivity-context/connectivity-service={uuid}/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.CostCharacteristicWrapper" 400: description: "Internal error" put: tags: - "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 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" required: false schema: $ref: "#/definitions/tapi.topology.CostCharacteristicWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 204: description: "Object modified" delete: tags: - "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 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/tapi-common:context/tapi-connectivity:connectivity-context/connectivity-service={uuid}/diversity-exclusion/: post: tags: - "tapi-connectivity" summary: "creates tapi.connectivity.ConnectivityServiceRef" description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" 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.ConnectivityServiceRefWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" ? /data/tapi-common:context/tapi-connectivity:connectivity-context/connectivity-service={uuid}/diversity-exclusion={connectivity-service-uuid}/ : get: tags: - "tapi-connectivity" summary: "returns tapi.connectivity.ConnectivityServiceRef" 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.connectivity.ConnectivityServiceRef" schema: $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRefWrapper" 400: description: "Internal error" put: tags: - "tapi-connectivity" summary: "creates or updates tapi.connectivity.ConnectivityServiceRef" 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" - in: "body" name: "tapi.connectivity.ConnectivityServiceRef.body-param" description: "tapi.connectivity.ConnectivityServiceRef to be added or updated" required: false schema: $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRefWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 204: description: "Object modified" delete: tags: - "tapi-connectivity" summary: "removes tapi.connectivity.ConnectivityServiceRef" 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: 400: description: "Internal error" 204: description: "Object deleted" /data/tapi-common:context/tapi-connectivity:connectivity-context/connectivity-service={uuid}/end-point/: post: tags: - "tapi-connectivity" summary: "creates tapi.connectivity.ConnectivityServiceEndPoint" description: "none" 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.ConnectivityServiceEndPointWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" /data/tapi-common:context/tapi-connectivity:connectivity-context/connectivity-service={uuid}/end-point={local-id}/: get: tags: - "tapi-connectivity" summary: "returns 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" responses: 200: description: "tapi.connectivity.ConnectivityServiceEndPoint" schema: $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointWrapper" 400: description: "Internal error" put: tags: - "tapi-connectivity" summary: "creates or updates 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 or\ \ updated" required: false schema: $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 204: description: "Object modified" delete: tags: - "tapi-connectivity" summary: "removes 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" responses: 400: description: "Internal error" 204: description: "Object deleted" /data/tapi-common:context/tapi-connectivity:connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/: get: tags: - "tapi-connectivity" 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.common.Capacity" schema: $ref: "#/definitions/tapi.common.CapacityWrapper" 400: description: "Internal error" post: tags: - "tapi-connectivity" 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.common.Capacity.body-param" description: "tapi.common.Capacity to be added to list" required: false schema: $ref: "#/definitions/tapi.common.CapacityWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" put: tags: - "tapi-connectivity" 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.CapacityWrapper" 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 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/tapi-common:context/tapi-connectivity:connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/ : get: tags: - "tapi-connectivity" summary: "returns tapi.common.BandwidthProfile" 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" schema: $ref: "#/definitions/tapi.common.BandwidthProfileWrapper" 400: description: "Internal error" post: tags: - "tapi-connectivity" summary: "creates tapi.common.BandwidthProfile" 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" required: false schema: $ref: "#/definitions/tapi.common.BandwidthProfileWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" put: tags: - "tapi-connectivity" summary: "creates or updates tapi.common.BandwidthProfile" 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" required: false schema: $ref: "#/definitions/tapi.common.BandwidthProfileWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 204: description: "Object modified" delete: tags: - "tapi-connectivity" summary: "removes tapi.common.BandwidthProfile" 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/tapi-common:context/tapi-connectivity:connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-burst-size/ : get: tags: - "tapi-connectivity" summary: "returns tapi.common.CapacityValue" 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" schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" 400: description: "Internal error" post: tags: - "tapi-connectivity" summary: "creates tapi.common.CapacityValue" 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" required: false schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" put: tags: - "tapi-connectivity" summary: "creates or updates tapi.common.CapacityValue" 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" required: false schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 204: description: "Object modified" delete: tags: - "tapi-connectivity" summary: "removes tapi.common.CapacityValue" 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/tapi-common:context/tapi-connectivity:connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-information-rate/ : get: tags: - "tapi-connectivity" summary: "returns tapi.common.CapacityValue" 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" schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" 400: description: "Internal error" post: tags: - "tapi-connectivity" summary: "creates tapi.common.CapacityValue" 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" required: false schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" put: tags: - "tapi-connectivity" summary: "creates or updates tapi.common.CapacityValue" 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" required: false schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 204: description: "Object modified" delete: tags: - "tapi-connectivity" summary: "removes tapi.common.CapacityValue" 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/tapi-common:context/tapi-connectivity:connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-burst-size/ : get: tags: - "tapi-connectivity" summary: "returns tapi.common.CapacityValue" 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" schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" 400: description: "Internal error" post: tags: - "tapi-connectivity" summary: "creates tapi.common.CapacityValue" 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" required: false schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" put: tags: - "tapi-connectivity" summary: "creates or updates tapi.common.CapacityValue" 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" required: false schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 204: description: "Object modified" delete: tags: - "tapi-connectivity" summary: "removes tapi.common.CapacityValue" 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/tapi-common:context/tapi-connectivity:connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-information-rate/ : get: tags: - "tapi-connectivity" summary: "returns tapi.common.CapacityValue" 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" schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" 400: description: "Internal error" post: tags: - "tapi-connectivity" summary: "creates tapi.common.CapacityValue" 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" required: false schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" put: tags: - "tapi-connectivity" summary: "creates or updates tapi.common.CapacityValue" 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" required: false schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 204: description: "Object modified" delete: tags: - "tapi-connectivity" summary: "removes tapi.common.CapacityValue" 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/tapi-common:context/tapi-connectivity:connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/total-size/ : get: tags: - "tapi-connectivity" 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.CapacityValue" schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" 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" - 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.CapacityValueWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" put: tags: - "tapi-connectivity" 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.CapacityValue.body-param" description: "tapi.common.CapacityValue to be added or updated" required: false schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" 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 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/tapi-common:context/tapi-connectivity: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" 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.ConnectionEndPointRefWrapper" 400: description: "Internal error" /data/tapi-common:context/tapi-connectivity:connectivity-context/connectivity-service={uuid}/end-point={local-id}/name/: post: tags: - "tapi-connectivity" summary: "creates tapi.common.NameAndValue" 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." 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.NameAndValueWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" ? /data/tapi-common:context/tapi-connectivity: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. 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." 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.NameAndValueWrapper" 400: description: "Internal error" put: tags: - "tapi-connectivity" summary: "creates or updates tapi.common.NameAndValue" 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." 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.NameAndValue.body-param" description: "tapi.common.NameAndValue to be added or updated" required: false schema: $ref: "#/definitions/tapi.common.NameAndValueWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 204: description: "Object modified" delete: tags: - "tapi-connectivity" summary: "removes tapi.common.NameAndValue" 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." 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/tapi-common:context/tapi-connectivity:connectivity-context/connectivity-service={uuid}/end-point={local-id}/peer-fwd-connectivity-service-end-point/ : get: tags: - "tapi-connectivity" 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.connectivity.ConnectivityServiceEndPointRef" schema: $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRefWrapper" 400: description: "Internal error" post: tags: - "tapi-connectivity" 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.connectivity.ConnectivityServiceEndPointRef.body-param" description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ \ to list" required: false schema: $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRefWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" put: tags: - "tapi-connectivity" 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.connectivity.ConnectivityServiceEndPointRef.body-param" description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ \ or updated" required: false schema: $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRefWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 204: description: "Object modified" delete: tags: - "tapi-connectivity" 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/tapi-common:context/tapi-connectivity:connectivity-context/connectivity-service={uuid}/end-point={local-id}/protecting-connectivity-service-end-point/ : get: tags: - "tapi-connectivity" 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.connectivity.ConnectivityServiceEndPointRef" schema: $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRefWrapper" 400: description: "Internal error" post: tags: - "tapi-connectivity" 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.connectivity.ConnectivityServiceEndPointRef.body-param" description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ \ to list" required: false schema: $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRefWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" put: tags: - "tapi-connectivity" 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.connectivity.ConnectivityServiceEndPointRef.body-param" description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ \ or updated" required: false schema: $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRefWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 204: description: "Object modified" delete: tags: - "tapi-connectivity" 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/tapi-common:context/tapi-connectivity: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 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.ConnectivityServiceEndPointRef" schema: $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRefWrapper" 400: description: "Internal error" post: tags: - "tapi-connectivity" 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.connectivity.ConnectivityServiceEndPointRef.body-param" description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ \ to list" required: false schema: $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRefWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" put: tags: - "tapi-connectivity" 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.connectivity.ConnectivityServiceEndPointRef.body-param" description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ \ or updated" required: false schema: $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRefWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 204: description: "Object modified" delete: tags: - "tapi-connectivity" 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/tapi-common:context/tapi-connectivity:connectivity-context/connectivity-service={uuid}/end-point={local-id}/service-interface-point/ : get: tags: - "tapi-connectivity" 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.ServiceInterfacePointRef" schema: $ref: "#/definitions/tapi.common.ServiceInterfacePointRefWrapper" 400: description: "Internal error" post: tags: - "tapi-connectivity" 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.ServiceInterfacePointRef.body-param" description: "tapi.common.ServiceInterfacePointRef to be added to list" required: false schema: $ref: "#/definitions/tapi.common.ServiceInterfacePointRefWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" put: tags: - "tapi-connectivity" 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.ServiceInterfacePointRef.body-param" description: "tapi.common.ServiceInterfacePointRef to be added or updated" required: false schema: $ref: "#/definitions/tapi.common.ServiceInterfacePointRefWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 204: description: "Object modified" delete: tags: - "tapi-connectivity" 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/tapi-common:context/tapi-connectivity:connectivity-context/connectivity-service={uuid}/latency-characteristic/: post: tags: - "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 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.LatencyCharacteristicWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" ? /data/tapi-common:context/tapi-connectivity:connectivity-context/connectivity-service={uuid}/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.LatencyCharacteristicWrapper" 400: description: "Internal error" put: tags: - "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 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" required: false schema: $ref: "#/definitions/tapi.topology.LatencyCharacteristicWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 204: description: "Object modified" delete: tags: - "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 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/tapi-common:context/tapi-connectivity:connectivity-context/connectivity-service={uuid}/max-allowed-cost/: get: tags: - "tapi-connectivity" summary: "returns tapi.path.computation.ValueOrPriority" description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" responses: 200: description: "tapi.path.computation.ValueOrPriority" schema: $ref: "#/definitions/tapi.path.computation.ValueOrPriorityWrapper" 400: description: "Internal error" post: tags: - "tapi-connectivity" summary: "creates tapi.path.computation.ValueOrPriority" description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - in: "body" name: "tapi.path.computation.ValueOrPriority.body-param" description: "tapi.path.computation.ValueOrPriority to be added to list" required: false schema: $ref: "#/definitions/tapi.path.computation.ValueOrPriorityWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" put: tags: - "tapi-connectivity" summary: "creates or updates tapi.path.computation.ValueOrPriority" description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - in: "body" name: "tapi.path.computation.ValueOrPriority.body-param" description: "tapi.path.computation.ValueOrPriority to be added or updated" required: false schema: $ref: "#/definitions/tapi.path.computation.ValueOrPriorityWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 204: description: "Object modified" delete: tags: - "tapi-connectivity" summary: "removes tapi.path.computation.ValueOrPriority" 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/tapi-common:context/tapi-connectivity:connectivity-context/connectivity-service={uuid}/max-allowed-delay/: get: tags: - "tapi-connectivity" summary: "returns tapi.path.computation.ValueOrPriority" description: "Delay unit is microseconds." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" responses: 200: description: "tapi.path.computation.ValueOrPriority" schema: $ref: "#/definitions/tapi.path.computation.ValueOrPriorityWrapper" 400: description: "Internal error" post: tags: - "tapi-connectivity" summary: "creates tapi.path.computation.ValueOrPriority" description: "Delay unit is microseconds." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - in: "body" name: "tapi.path.computation.ValueOrPriority.body-param" description: "tapi.path.computation.ValueOrPriority to be added to list" required: false schema: $ref: "#/definitions/tapi.path.computation.ValueOrPriorityWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" put: tags: - "tapi-connectivity" summary: "creates or updates tapi.path.computation.ValueOrPriority" description: "Delay unit is microseconds." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - in: "body" name: "tapi.path.computation.ValueOrPriority.body-param" description: "tapi.path.computation.ValueOrPriority to be added or updated" required: false schema: $ref: "#/definitions/tapi.path.computation.ValueOrPriorityWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 204: description: "Object modified" delete: tags: - "tapi-connectivity" summary: "removes tapi.path.computation.ValueOrPriority" description: "Delay unit is microseconds." parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" /data/tapi-common:context/tapi-connectivity:connectivity-context/connectivity-service={uuid}/max-allowed-hops/: get: tags: - "tapi-connectivity" summary: "returns tapi.path.computation.ValueOrPriority" description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" responses: 200: description: "tapi.path.computation.ValueOrPriority" schema: $ref: "#/definitions/tapi.path.computation.ValueOrPriorityWrapper" 400: description: "Internal error" post: tags: - "tapi-connectivity" summary: "creates tapi.path.computation.ValueOrPriority" description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - in: "body" name: "tapi.path.computation.ValueOrPriority.body-param" description: "tapi.path.computation.ValueOrPriority to be added to list" required: false schema: $ref: "#/definitions/tapi.path.computation.ValueOrPriorityWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" put: tags: - "tapi-connectivity" summary: "creates or updates tapi.path.computation.ValueOrPriority" description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" - in: "body" name: "tapi.path.computation.ValueOrPriority.body-param" description: "tapi.path.computation.ValueOrPriority to be added or updated" required: false schema: $ref: "#/definitions/tapi.path.computation.ValueOrPriorityWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 204: description: "Object modified" delete: tags: - "tapi-connectivity" summary: "removes tapi.path.computation.ValueOrPriority" 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/tapi-common:context/tapi-connectivity:connectivity-context/connectivity-service={uuid}/name/: post: tags: - "tapi-connectivity" summary: "creates tapi.common.NameAndValue" 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." 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.NameAndValueWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" /data/tapi-common:context/tapi-connectivity:connectivity-context/connectivity-service={uuid}/name={value-name}/: get: tags: - "tapi-connectivity" summary: "returns tapi.common.NameAndValue" 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." 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.NameAndValueWrapper" 400: description: "Internal error" put: tags: - "tapi-connectivity" summary: "creates or updates tapi.common.NameAndValue" 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." 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 or updated" required: false schema: $ref: "#/definitions/tapi.common.NameAndValueWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 204: description: "Object modified" delete: tags: - "tapi-connectivity" summary: "removes tapi.common.NameAndValue" 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." 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/tapi-common:context/tapi-connectivity:connectivity-context/connectivity-service={uuid}/requested-capacity/: get: tags: - "tapi-connectivity" summary: "returns tapi.common.Capacity" description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" responses: 200: description: "tapi.common.Capacity" schema: $ref: "#/definitions/tapi.common.CapacityWrapper" 400: description: "Internal error" post: tags: - "tapi-connectivity" summary: "creates tapi.common.Capacity" 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.CapacityWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" put: tags: - "tapi-connectivity" summary: "creates or updates tapi.common.Capacity" 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 or updated" required: false schema: $ref: "#/definitions/tapi.common.CapacityWrapper" 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 connectivity-service" required: true type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" ? /data/tapi-common:context/tapi-connectivity:connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/ : get: tags: - "tapi-connectivity" summary: "returns tapi.common.BandwidthProfile" description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" responses: 200: description: "tapi.common.BandwidthProfile" schema: $ref: "#/definitions/tapi.common.BandwidthProfileWrapper" 400: description: "Internal error" post: tags: - "tapi-connectivity" summary: "creates tapi.common.BandwidthProfile" 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.BandwidthProfileWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" put: tags: - "tapi-connectivity" summary: "creates or updates tapi.common.BandwidthProfile" 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 or updated" required: false schema: $ref: "#/definitions/tapi.common.BandwidthProfileWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 204: description: "Object modified" delete: tags: - "tapi-connectivity" summary: "removes tapi.common.BandwidthProfile" 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/tapi-common:context/tapi-connectivity:connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/committed-burst-size/ : get: tags: - "tapi-connectivity" summary: "returns tapi.common.CapacityValue" description: "none" 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.CapacityValueWrapper" 400: description: "Internal error" post: tags: - "tapi-connectivity" summary: "creates tapi.common.CapacityValue" 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.CapacityValueWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" put: tags: - "tapi-connectivity" summary: "creates or updates tapi.common.CapacityValue" 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.CapacityValueWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 204: description: "Object modified" delete: tags: - "tapi-connectivity" summary: "removes tapi.common.CapacityValue" 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/tapi-common:context/tapi-connectivity:connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/committed-information-rate/ : get: tags: - "tapi-connectivity" summary: "returns tapi.common.CapacityValue" description: "none" 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.CapacityValueWrapper" 400: description: "Internal error" post: tags: - "tapi-connectivity" summary: "creates tapi.common.CapacityValue" 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.CapacityValueWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" put: tags: - "tapi-connectivity" summary: "creates or updates tapi.common.CapacityValue" 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.CapacityValueWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 204: description: "Object modified" delete: tags: - "tapi-connectivity" summary: "removes tapi.common.CapacityValue" 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/tapi-common:context/tapi-connectivity:connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/peak-burst-size/ : get: tags: - "tapi-connectivity" summary: "returns tapi.common.CapacityValue" description: "none" 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.CapacityValueWrapper" 400: description: "Internal error" post: tags: - "tapi-connectivity" summary: "creates tapi.common.CapacityValue" 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.CapacityValueWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" put: tags: - "tapi-connectivity" summary: "creates or updates tapi.common.CapacityValue" 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.CapacityValueWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 204: description: "Object modified" delete: tags: - "tapi-connectivity" summary: "removes tapi.common.CapacityValue" 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/tapi-common:context/tapi-connectivity:connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/peak-information-rate/ : get: tags: - "tapi-connectivity" summary: "returns tapi.common.CapacityValue" description: "none" 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.CapacityValueWrapper" 400: description: "Internal error" post: tags: - "tapi-connectivity" summary: "creates tapi.common.CapacityValue" 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.CapacityValueWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" put: tags: - "tapi-connectivity" summary: "creates or updates tapi.common.CapacityValue" 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.CapacityValueWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 204: description: "Object modified" delete: tags: - "tapi-connectivity" summary: "removes tapi.common.CapacityValue" 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/tapi-common:context/tapi-connectivity:connectivity-context/connectivity-service={uuid}/requested-capacity/total-size/: get: tags: - "tapi-connectivity" 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" responses: 200: description: "tapi.common.CapacityValue" schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" 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.common.CapacityValue.body-param" description: "tapi.common.CapacityValue to be added to list" required: false schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" put: tags: - "tapi-connectivity" 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" - in: "body" name: "tapi.common.CapacityValue.body-param" description: "tapi.common.CapacityValue to be added or updated" required: false schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" 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 connectivity-service" required: true type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" /data/tapi-common:context/tapi-connectivity:connectivity-context/connectivity-service={uuid}/resilience-type/: get: tags: - "tapi-connectivity" summary: "returns tapi.topology.ResilienceType" description: "none" 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.ResilienceTypeWrapper" 400: description: "Internal error" post: tags: - "tapi-connectivity" summary: "creates tapi.topology.ResilienceType" 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" required: false schema: $ref: "#/definitions/tapi.topology.ResilienceTypeWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" put: tags: - "tapi-connectivity" summary: "creates or updates tapi.topology.ResilienceType" 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 or updated" required: false schema: $ref: "#/definitions/tapi.topology.ResilienceTypeWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 204: description: "Object modified" delete: tags: - "tapi-connectivity" summary: "removes tapi.topology.ResilienceType" 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/tapi-common:context/tapi-connectivity:connectivity-context/connectivity-service={uuid}/risk-diversity-characteristic/: post: tags: - "tapi-connectivity" 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.RiskCharacteristicWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" ? /data/tapi-common:context/tapi-connectivity:connectivity-context/connectivity-service={uuid}/risk-diversity-characteristic={risk-characteristic-name}/ : get: tags: - "tapi-connectivity" summary: "returns 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: 200: description: "tapi.topology.RiskCharacteristic" schema: $ref: "#/definitions/tapi.topology.RiskCharacteristicWrapper" 400: description: "Internal error" put: tags: - "tapi-connectivity" 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.topology.RiskCharacteristic.body-param" description: "tapi.topology.RiskCharacteristic to be added or updated" required: false schema: $ref: "#/definitions/tapi.topology.RiskCharacteristicWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 204: description: "Object modified" delete: tags: - "tapi-connectivity" 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/tapi-common:context/tapi-connectivity:connectivity-context/connectivity-service={uuid}/schedule/: get: tags: - "tapi-connectivity" summary: "returns tapi.common.TimeRange" description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" responses: 200: description: "tapi.common.TimeRange" schema: $ref: "#/definitions/tapi.common.TimeRangeWrapper" 400: description: "Internal error" post: tags: - "tapi-connectivity" summary: "creates tapi.common.TimeRange" description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" 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.TimeRangeWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" put: tags: - "tapi-connectivity" summary: "creates or updates tapi.common.TimeRange" description: "none" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" 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.TimeRangeWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 204: description: "Object modified" delete: tags: - "tapi-connectivity" summary: "removes tapi.common.TimeRange" 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/tapi-common:context/tapi-notification: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.NotificationContextWrapper" 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.NotificationContextWrapper" 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.NotificationContextWrapper" 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/tapi-common:context/tapi-notification: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.NotificationSubscriptionServiceWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" /data/tapi-common:context/tapi-notification: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.NotificationSubscriptionServiceWrapper" 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.NotificationSubscriptionServiceWrapper" 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/tapi-common:context/tapi-notification:notification-context/notif-subscription={uuid}/name/: post: tags: - "tapi-notification" summary: "creates tapi.common.NameAndValue" 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." 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.NameAndValueWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" /data/tapi-common:context/tapi-notification:notification-context/notif-subscription={uuid}/name={value-name}/: get: tags: - "tapi-notification" summary: "returns tapi.common.NameAndValue" 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." 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.NameAndValueWrapper" 400: description: "Internal error" put: tags: - "tapi-notification" summary: "creates or updates tapi.common.NameAndValue" 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." 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.NameAndValueWrapper" 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. 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." 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/tapi-common:context/tapi-notification: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.NotificationChannelWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-notification:notification-context/notif-subscription={uuid}/notification-channel/name={value-name}/ : get: tags: - "tapi-notification" summary: "returns tapi.common.NameAndValue" 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." 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.NameAndValueWrapper" 400: description: "Internal error" /data/tapi-common:context/tapi-notification: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.NotificationWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-notification: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.NameAndValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-notification:notification-context/notif-subscription={uuid}/notification={notification-uuid}/alarm-info/ : get: tags: - "tapi-notification" summary: "returns tapi.notification.AlarmInfo" 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" schema: $ref: "#/definitions/tapi.notification.AlarmInfoWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-notification: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.NameAndValueChangeWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-notification:notification-context/notif-subscription={uuid}/notification={notification-uuid}/name={value-name}/ : get: tags: - "tapi-notification" summary: "returns tapi.common.NameAndValue" 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." 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.NameAndValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-notification: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.NameAndValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-notification:notification-context/notif-subscription={uuid}/notification={notification-uuid}/tca-info/ : get: tags: - "tapi-notification" summary: "returns tapi.notification.TcaInfo" 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.TcaInfo" schema: $ref: "#/definitions/tapi.notification.TcaInfoWrapper" 400: description: "Internal error" /data/tapi-common:context/tapi-notification: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.SubscriptionFilterWrapper" 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.SubscriptionFilterWrapper" 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.SubscriptionFilterWrapper" 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/tapi-common:context/tapi-notification:notification-context/notif-subscription={uuid}/subscription-filter/name/: post: tags: - "tapi-notification" summary: "creates tapi.common.NameAndValue" 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." 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.NameAndValueWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" ? /data/tapi-common:context/tapi-notification:notification-context/notif-subscription={uuid}/subscription-filter/name={value-name}/ : get: tags: - "tapi-notification" summary: "returns tapi.common.NameAndValue" 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." 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.NameAndValueWrapper" 400: description: "Internal error" put: tags: - "tapi-notification" summary: "creates or updates tapi.common.NameAndValue" 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." 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.NameAndValueWrapper" 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. 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." 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/tapi-common:context/tapi-notification: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.NotificationWrapper" 400: description: "Internal error" /data/tapi-common:context/tapi-notification: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.NameAndValueWrapper" 400: description: "Internal error" /data/tapi-common:context/tapi-notification:notification-context/notification={uuid}/alarm-info/: get: tags: - "tapi-notification" summary: "returns tapi.notification.AlarmInfo" description: "none" parameters: - name: "uuid" in: "path" description: "Id of notification" required: true type: "string" responses: 200: description: "tapi.notification.AlarmInfo" schema: $ref: "#/definitions/tapi.notification.AlarmInfoWrapper" 400: description: "Internal error" /data/tapi-common:context/tapi-notification: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.NameAndValueChangeWrapper" 400: description: "Internal error" /data/tapi-common:context/tapi-notification:notification-context/notification={uuid}/name={value-name}/: get: tags: - "tapi-notification" summary: "returns tapi.common.NameAndValue" 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." 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.NameAndValueWrapper" 400: description: "Internal error" /data/tapi-common:context/tapi-notification: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.NameAndValueWrapper" 400: description: "Internal error" /data/tapi-common:context/tapi-notification:notification-context/notification={uuid}/tca-info/: get: tags: - "tapi-notification" summary: "returns tapi.notification.TcaInfo" description: "none" parameters: - name: "uuid" in: "path" description: "Id of notification" required: true type: "string" responses: 200: description: "tapi.notification.TcaInfo" schema: $ref: "#/definitions/tapi.notification.TcaInfoWrapper" 400: description: "Internal error" /data/tapi-common:context/tapi-path-computation: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.PathComputationContextWrapper" 400: description: "Internal error" post: tags: - "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.PathComputationContextWrapper" 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.PathComputationContextWrapper" 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/tapi-common:context/tapi-path-computation: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.PathComputationServiceWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" /data/tapi-common:context/tapi-path-computation: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 path-comp-service" required: true type: "string" responses: 200: description: "tapi.path.computation.PathComputationService" schema: $ref: "#/definitions/tapi.path.computation.PathComputationServiceWrapper" 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 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.PathComputationServiceWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 204: description: "Object modified" delete: tags: - "tapi-path-computation" summary: "removes tapi.path.computation.PathComputationService" 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/tapi-common:context/tapi-path-computation: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 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.PathServiceEndPointWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" /data/tapi-common:context/tapi-path-computation: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.PathServiceEndPointWrapper" 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.path.computation.PathServiceEndPoint.body-param" description: "tapi.path.computation.PathServiceEndPoint to be added or updated" required: false schema: $ref: "#/definitions/tapi.path.computation.PathServiceEndPointWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 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/tapi-common:context/tapi-path-computation: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 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" schema: $ref: "#/definitions/tapi.common.CapacityWrapper" 400: description: "Internal error" post: tags: - "tapi-path-computation" summary: "creates tapi.common.Capacity" 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" required: false schema: $ref: "#/definitions/tapi.common.CapacityWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" put: tags: - "tapi-path-computation" summary: "creates or updates tapi.common.Capacity" 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" required: false schema: $ref: "#/definitions/tapi.common.CapacityWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 204: description: "Object modified" delete: tags: - "tapi-path-computation" summary: "removes tapi.common.Capacity" 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/tapi-common:context/tapi-path-computation:path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/ : get: tags: - "tapi-path-computation" summary: "returns tapi.common.BandwidthProfile" 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.BandwidthProfile" schema: $ref: "#/definitions/tapi.common.BandwidthProfileWrapper" 400: description: "Internal error" post: tags: - "tapi-path-computation" summary: "creates tapi.common.BandwidthProfile" 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.BandwidthProfile.body-param" description: "tapi.common.BandwidthProfile to be added to list" required: false schema: $ref: "#/definitions/tapi.common.BandwidthProfileWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" put: tags: - "tapi-path-computation" summary: "creates or updates tapi.common.BandwidthProfile" 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.BandwidthProfile.body-param" description: "tapi.common.BandwidthProfile to be added or updated" required: false schema: $ref: "#/definitions/tapi.common.BandwidthProfileWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 204: description: "Object modified" delete: tags: - "tapi-path-computation" summary: "removes tapi.common.BandwidthProfile" 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/tapi-common:context/tapi-path-computation:path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-burst-size/ : get: tags: - "tapi-path-computation" summary: "returns tapi.common.CapacityValue" 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" schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" 400: description: "Internal error" post: tags: - "tapi-path-computation" summary: "creates tapi.common.CapacityValue" 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" required: false schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" put: tags: - "tapi-path-computation" summary: "creates or updates tapi.common.CapacityValue" 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" required: false schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 204: description: "Object modified" delete: tags: - "tapi-path-computation" summary: "removes tapi.common.CapacityValue" 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/tapi-common:context/tapi-path-computation:path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-information-rate/ : get: tags: - "tapi-path-computation" summary: "returns tapi.common.CapacityValue" 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" schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" 400: description: "Internal error" post: tags: - "tapi-path-computation" summary: "creates tapi.common.CapacityValue" 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" required: false schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" put: tags: - "tapi-path-computation" summary: "creates or updates tapi.common.CapacityValue" 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" required: false schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 204: description: "Object modified" delete: tags: - "tapi-path-computation" summary: "removes tapi.common.CapacityValue" 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/tapi-common:context/tapi-path-computation:path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-burst-size/ : get: tags: - "tapi-path-computation" summary: "returns tapi.common.CapacityValue" 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" schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" 400: description: "Internal error" post: tags: - "tapi-path-computation" summary: "creates tapi.common.CapacityValue" 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" required: false schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" put: tags: - "tapi-path-computation" summary: "creates or updates tapi.common.CapacityValue" 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" required: false schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 204: description: "Object modified" delete: tags: - "tapi-path-computation" summary: "removes tapi.common.CapacityValue" 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/tapi-common:context/tapi-path-computation:path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-information-rate/ : get: tags: - "tapi-path-computation" summary: "returns tapi.common.CapacityValue" 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" schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" 400: description: "Internal error" post: tags: - "tapi-path-computation" summary: "creates tapi.common.CapacityValue" 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" required: false schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" put: tags: - "tapi-path-computation" summary: "creates or updates tapi.common.CapacityValue" 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" required: false schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 204: description: "Object modified" delete: tags: - "tapi-path-computation" summary: "removes tapi.common.CapacityValue" 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/tapi-common:context/tapi-path-computation:path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/total-size/ : get: tags: - "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 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" schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" 400: description: "Internal error" post: tags: - "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 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.CapacityValueWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" put: tags: - "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 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" required: false schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 204: description: "Object modified" delete: tags: - "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 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/tapi-common:context/tapi-path-computation:path-computation-context/path-comp-service={uuid}/end-point={local-id}/name/: post: tags: - "tapi-path-computation" summary: "creates tapi.common.NameAndValue" 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." 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.NameAndValueWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" ? /data/tapi-common:context/tapi-path-computation: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. 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." 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.NameAndValueWrapper" 400: description: "Internal error" put: tags: - "tapi-path-computation" summary: "creates or updates tapi.common.NameAndValue" 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." 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.NameAndValueWrapper" 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. 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." 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/tapi-common:context/tapi-path-computation: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.ServiceInterfacePointRefWrapper" 400: description: "Internal error" post: tags: - "tapi-path-computation" 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.common.ServiceInterfacePointRef.body-param" description: "tapi.common.ServiceInterfacePointRef to be added to list" required: false schema: $ref: "#/definitions/tapi.common.ServiceInterfacePointRefWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" put: tags: - "tapi-path-computation" 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.common.ServiceInterfacePointRef.body-param" description: "tapi.common.ServiceInterfacePointRef to be added or updated" required: false schema: $ref: "#/definitions/tapi.common.ServiceInterfacePointRefWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 204: description: "Object modified" delete: tags: - "tapi-path-computation" 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/tapi-common:context/tapi-path-computation:path-computation-context/path-comp-service={uuid}/name/: post: tags: - "tapi-path-computation" summary: "creates tapi.common.NameAndValue" 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." 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.NameAndValueWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" /data/tapi-common:context/tapi-path-computation:path-computation-context/path-comp-service={uuid}/name={value-name}/: get: tags: - "tapi-path-computation" summary: "returns tapi.common.NameAndValue" 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." 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.NameAndValueWrapper" 400: description: "Internal error" put: tags: - "tapi-path-computation" summary: "creates or updates tapi.common.NameAndValue" 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." 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.NameAndValueWrapper" 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. 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." 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/tapi-common:context/tapi-path-computation:path-computation-context/path-comp-service={uuid}/objective-function/: get: tags: - "tapi-path-computation" summary: "returns tapi.path.computation.PathObjectiveFunction" description: "none" 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.PathObjectiveFunctionWrapper" 400: description: "Internal error" post: tags: - "tapi-path-computation" summary: "creates tapi.path.computation.PathObjectiveFunction" 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" required: false schema: $ref: "#/definitions/tapi.path.computation.PathObjectiveFunctionWrapper" 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.PathObjectiveFunction" 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 or updated" required: false schema: $ref: "#/definitions/tapi.path.computation.PathObjectiveFunctionWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 204: description: "Object modified" delete: tags: - "tapi-path-computation" summary: "removes tapi.path.computation.PathObjectiveFunction" 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/tapi-common:context/tapi-path-computation:path-computation-context/path-comp-service={uuid}/objective-function/name/: post: tags: - "tapi-path-computation" summary: "creates tapi.common.NameAndValue" 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." 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.NameAndValueWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" ? /data/tapi-common:context/tapi-path-computation:path-computation-context/path-comp-service={uuid}/objective-function/name={value-name}/ : get: tags: - "tapi-path-computation" summary: "returns tapi.common.NameAndValue" 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." 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.NameAndValueWrapper" 400: description: "Internal error" put: tags: - "tapi-path-computation" summary: "creates or updates tapi.common.NameAndValue" 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." 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.NameAndValueWrapper" 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. 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." 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/tapi-common:context/tapi-path-computation: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" description: "Id of path-comp-service" required: true type: "string" responses: 200: description: "tapi.path.computation.PathOptimizationConstraint" schema: $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraintWrapper" 400: description: "Internal error" post: tags: - "tapi-path-computation" summary: "creates tapi.path.computation.PathOptimizationConstraint" 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.PathOptimizationConstraintWrapper" 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.PathOptimizationConstraint" 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\ \ or updated" required: false schema: $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraintWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 204: description: "Object modified" delete: tags: - "tapi-path-computation" summary: "removes tapi.path.computation.PathOptimizationConstraint" 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/tapi-common:context/tapi-path-computation:path-computation-context/path-comp-service={uuid}/optimization-constraint/name/: post: tags: - "tapi-path-computation" summary: "creates tapi.common.NameAndValue" 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." 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.NameAndValueWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" ? /data/tapi-common:context/tapi-path-computation:path-computation-context/path-comp-service={uuid}/optimization-constraint/name={value-name}/ : get: tags: - "tapi-path-computation" summary: "returns tapi.common.NameAndValue" 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." 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.NameAndValueWrapper" 400: description: "Internal error" put: tags: - "tapi-path-computation" summary: "creates or updates tapi.common.NameAndValue" 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." 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.NameAndValueWrapper" 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. 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." 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/tapi-common:context/tapi-path-computation: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.PathRefWrapper" 400: description: "Internal error" /data/tapi-common:context/tapi-path-computation: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.RoutingConstraintWrapper" 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.RoutingConstraintWrapper" 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.RoutingConstraintWrapper" 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/tapi-common:context/tapi-path-computation: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" name: "tapi.topology.CostCharacteristic.body-param" description: "tapi.topology.CostCharacteristic to be added to list" required: false schema: $ref: "#/definitions/tapi.topology.CostCharacteristicWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" ? /data/tapi-common:context/tapi-path-computation: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.CostCharacteristicWrapper" 400: description: "Internal error" put: tags: - "tapi-path-computation" 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: "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.CostCharacteristicWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 204: description: "Object modified" delete: tags: - "tapi-path-computation" 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: "cost-name" in: "path" description: "Id of cost-characteristic" required: true type: "string" responses: 400: description: "Internal error" 204: description: "Object deleted" ? /data/tapi-common:context/tapi-path-computation:path-computation-context/path-comp-service={uuid}/routing-constraint/latency-characteristic/ : post: tags: - "tapi-path-computation" 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.LatencyCharacteristicWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" ? /data/tapi-common:context/tapi-path-computation:path-computation-context/path-comp-service={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/ : get: tags: - "tapi-path-computation" 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: "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.LatencyCharacteristicWrapper" 400: description: "Internal error" put: tags: - "tapi-path-computation" 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.topology.LatencyCharacteristic.body-param" description: "tapi.topology.LatencyCharacteristic to be added or updated" required: false schema: $ref: "#/definitions/tapi.topology.LatencyCharacteristicWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 204: description: "Object modified" delete: tags: - "tapi-path-computation" 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/tapi-common:context/tapi-path-computation:path-computation-context/path-comp-service={uuid}/routing-constraint/max-allowed-cost/ : get: tags: - "tapi-path-computation" summary: "returns tapi.path.computation.ValueOrPriority" description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" responses: 200: description: "tapi.path.computation.ValueOrPriority" schema: $ref: "#/definitions/tapi.path.computation.ValueOrPriorityWrapper" 400: description: "Internal error" post: tags: - "tapi-path-computation" summary: "creates tapi.path.computation.ValueOrPriority" description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - in: "body" name: "tapi.path.computation.ValueOrPriority.body-param" description: "tapi.path.computation.ValueOrPriority to be added to list" required: false schema: $ref: "#/definitions/tapi.path.computation.ValueOrPriorityWrapper" 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.ValueOrPriority" description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - in: "body" name: "tapi.path.computation.ValueOrPriority.body-param" description: "tapi.path.computation.ValueOrPriority to be added or updated" required: false schema: $ref: "#/definitions/tapi.path.computation.ValueOrPriorityWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 204: description: "Object modified" delete: tags: - "tapi-path-computation" summary: "removes tapi.path.computation.ValueOrPriority" 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/tapi-common:context/tapi-path-computation:path-computation-context/path-comp-service={uuid}/routing-constraint/max-allowed-delay/ : get: tags: - "tapi-path-computation" summary: "returns tapi.path.computation.ValueOrPriority" description: "Delay unit is microseconds." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" responses: 200: description: "tapi.path.computation.ValueOrPriority" schema: $ref: "#/definitions/tapi.path.computation.ValueOrPriorityWrapper" 400: description: "Internal error" post: tags: - "tapi-path-computation" summary: "creates tapi.path.computation.ValueOrPriority" description: "Delay unit is microseconds." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - in: "body" name: "tapi.path.computation.ValueOrPriority.body-param" description: "tapi.path.computation.ValueOrPriority to be added to list" required: false schema: $ref: "#/definitions/tapi.path.computation.ValueOrPriorityWrapper" 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.ValueOrPriority" description: "Delay unit is microseconds." parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - in: "body" name: "tapi.path.computation.ValueOrPriority.body-param" description: "tapi.path.computation.ValueOrPriority to be added or updated" required: false schema: $ref: "#/definitions/tapi.path.computation.ValueOrPriorityWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 204: description: "Object modified" delete: tags: - "tapi-path-computation" summary: "removes tapi.path.computation.ValueOrPriority" description: "Delay unit is microseconds." 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/tapi-common:context/tapi-path-computation:path-computation-context/path-comp-service={uuid}/routing-constraint/max-allowed-hops/ : get: tags: - "tapi-path-computation" summary: "returns tapi.path.computation.ValueOrPriority" description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" responses: 200: description: "tapi.path.computation.ValueOrPriority" schema: $ref: "#/definitions/tapi.path.computation.ValueOrPriorityWrapper" 400: description: "Internal error" post: tags: - "tapi-path-computation" summary: "creates tapi.path.computation.ValueOrPriority" description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - in: "body" name: "tapi.path.computation.ValueOrPriority.body-param" description: "tapi.path.computation.ValueOrPriority to be added to list" required: false schema: $ref: "#/definitions/tapi.path.computation.ValueOrPriorityWrapper" 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.ValueOrPriority" description: "none" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" - in: "body" name: "tapi.path.computation.ValueOrPriority.body-param" description: "tapi.path.computation.ValueOrPriority to be added or updated" required: false schema: $ref: "#/definitions/tapi.path.computation.ValueOrPriorityWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 204: description: "Object modified" delete: tags: - "tapi-path-computation" summary: "removes tapi.path.computation.ValueOrPriority" 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/tapi-common:context/tapi-path-computation:path-computation-context/path-comp-service={uuid}/routing-constraint/risk-diversity-characteristic/ : post: tags: - "tapi-path-computation" summary: "creates tapi.topology.RiskCharacteristic" description: "none" 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.RiskCharacteristicWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 409: description: "Object already exists" ? /data/tapi-common:context/tapi-path-computation:path-computation-context/path-comp-service={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/ : get: tags: - "tapi-path-computation" summary: "returns tapi.topology.RiskCharacteristic" 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" responses: 200: description: "tapi.topology.RiskCharacteristic" schema: $ref: "#/definitions/tapi.topology.RiskCharacteristicWrapper" 400: description: "Internal error" put: tags: - "tapi-path-computation" 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: "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.RiskCharacteristicWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 204: description: "Object modified" delete: tags: - "tapi-path-computation" summary: "removes tapi.topology.RiskCharacteristic" 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" responses: 400: description: "Internal error" 204: description: "Object deleted" /data/tapi-common:context/tapi-path-computation:path-computation-context/path-comp-service={uuid}/topology-constraint/: get: tags: - "tapi-path-computation" summary: "returns 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.TopologyConstraint" schema: $ref: "#/definitions/tapi.path.computation.TopologyConstraintWrapper" 400: description: "Internal error" post: tags: - "tapi-path-computation" summary: "creates 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.TopologyConstraint.body-param" description: "tapi.path.computation.TopologyConstraint to be added to list" required: false schema: $ref: "#/definitions/tapi.path.computation.TopologyConstraintWrapper" 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.TopologyConstraint" description: "none" 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.TopologyConstraintWrapper" responses: 201: description: "Object created" 400: description: "Internal error" 204: description: "Object modified" delete: tags: - "tapi-path-computation" summary: "removes tapi.path.computation.TopologyConstraint" 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/tapi-common:context/tapi-path-computation:path-computation-context/path={uuid}/: get: tags: - "tapi-path-computation" summary: "returns tapi.path.computation.Path" description: "none" 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.PathWrapper" 400: description: "Internal error" /data/tapi-common:context/tapi-path-computation:path-computation-context/path={uuid}/link={topology-uuid},{link-uuid}/: get: tags: - "tapi-path-computation" summary: "returns tapi.topology.LinkRef" description: "none" 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.LinkRefWrapper" 400: description: "Internal error" /data/tapi-common:context/tapi-path-computation:path-computation-context/path={uuid}/name={value-name}/: get: tags: - "tapi-path-computation" summary: "returns tapi.common.NameAndValue" 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." 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.NameAndValueWrapper" 400: description: "Internal error" /data/tapi-common:context/tapi-path-computation:path-computation-context/path={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" required: true type: "string" responses: 200: description: "tapi.path.computation.RoutingConstraint" schema: $ref: "#/definitions/tapi.path.computation.RoutingConstraintWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-path-computation: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 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.CostCharacteristicWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-path-computation:path-computation-context/path={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/ : get: tags: - "tapi-path-computation" 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" 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.LatencyCharacteristicWrapper" 400: description: "Internal error" /data/tapi-common:context/tapi-path-computation:path-computation-context/path={uuid}/routing-constraint/max-allowed-cost/: get: tags: - "tapi-path-computation" summary: "returns tapi.path.computation.ValueOrPriority" description: "none" parameters: - name: "uuid" in: "path" description: "Id of path" required: true type: "string" responses: 200: description: "tapi.path.computation.ValueOrPriority" schema: $ref: "#/definitions/tapi.path.computation.ValueOrPriorityWrapper" 400: description: "Internal error" /data/tapi-common:context/tapi-path-computation:path-computation-context/path={uuid}/routing-constraint/max-allowed-delay/: get: tags: - "tapi-path-computation" summary: "returns tapi.path.computation.ValueOrPriority" description: "Delay unit is microseconds." parameters: - name: "uuid" in: "path" description: "Id of path" required: true type: "string" responses: 200: description: "tapi.path.computation.ValueOrPriority" schema: $ref: "#/definitions/tapi.path.computation.ValueOrPriorityWrapper" 400: description: "Internal error" /data/tapi-common:context/tapi-path-computation:path-computation-context/path={uuid}/routing-constraint/max-allowed-hops/: get: tags: - "tapi-path-computation" summary: "returns tapi.path.computation.ValueOrPriority" description: "none" parameters: - name: "uuid" in: "path" description: "Id of path" required: true type: "string" responses: 200: description: "tapi.path.computation.ValueOrPriority" schema: $ref: "#/definitions/tapi.path.computation.ValueOrPriorityWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-path-computation:path-computation-context/path={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/ : get: tags: - "tapi-path-computation" summary: "returns tapi.topology.RiskCharacteristic" description: "none" 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.RiskCharacteristicWrapper" 400: description: "Internal error" /data/tapi-common:context/tapi-topology: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.TopologyContextWrapper" 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.TopologyContextWrapper" 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.TopologyContextWrapper" 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/tapi-common:context/tapi-topology: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.NetworkTopologyServiceWrapper" 400: description: "Internal error" /data/tapi-common:context/tapi-topology:topology-context/nw-topology-service/name={value-name}/: get: tags: - "tapi-topology" summary: "returns tapi.common.NameAndValue" 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." 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.NameAndValueWrapper" 400: description: "Internal error" /data/tapi-common:context/tapi-topology: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.TopologyRefWrapper" 400: description: "Internal error" /data/tapi-common:context/tapi-topology: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.Topology" schema: $ref: "#/definitions/tapi.topology.TopologyWrapper" 400: description: "Internal error" /data/tapi-common:context/tapi-topology: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.LinkWrapper" 400: description: "Internal error" /data/tapi-common:context/tapi-topology: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.CapacityWrapper" 400: description: "Internal error" /data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/: get: tags: - "tapi-topology" summary: "returns tapi.common.BandwidthProfile" 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.common.BandwidthProfile" schema: $ref: "#/definitions/tapi.common.BandwidthProfileWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ : get: tags: - "tapi-topology" summary: "returns tapi.common.CapacityValue" 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.common.CapacityValue" schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ : get: tags: - "tapi-topology" summary: "returns tapi.common.CapacityValue" 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.common.CapacityValue" schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ : get: tags: - "tapi-topology" summary: "returns tapi.common.CapacityValue" 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.common.CapacityValue" schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ : get: tags: - "tapi-topology" summary: "returns tapi.common.CapacityValue" 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.common.CapacityValue" schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" 400: description: "Internal error" /data/tapi-common:context/tapi-topology: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.CapacityValueWrapper" 400: description: "Internal error" /data/tapi-common:context/tapi-topology: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.CostCharacteristicWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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.LatencyCharacteristicWrapper" 400: description: "Internal error" /data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/link={link-uuid}/name={value-name}/: get: tags: - "tapi-topology" summary: "returns tapi.common.NameAndValue" 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." 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.NameAndValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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.NodeEdgePointRefWrapper" 400: description: "Internal error" /data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/link={link-uuid}/resilience-type/: get: tags: - "tapi-topology" summary: "returns tapi.topology.ResilienceType" 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.ResilienceType" schema: $ref: "#/definitions/tapi.topology.ResilienceTypeWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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.RiskCharacteristicWrapper" 400: description: "Internal error" /data/tapi-common:context/tapi-topology: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.CapacityWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/ : get: tags: - "tapi-topology" summary: "returns tapi.common.BandwidthProfile" 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.common.BandwidthProfile" schema: $ref: "#/definitions/tapi.common.BandwidthProfileWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ : get: tags: - "tapi-topology" summary: "returns tapi.common.CapacityValue" 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.common.CapacityValue" schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ : get: tags: - "tapi-topology" summary: "returns tapi.common.CapacityValue" 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.common.CapacityValue" schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ : get: tags: - "tapi-topology" summary: "returns tapi.common.CapacityValue" 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.common.CapacityValue" schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ : get: tags: - "tapi-topology" summary: "returns tapi.common.CapacityValue" 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.common.CapacityValue" schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" 400: description: "Internal error" /data/tapi-common:context/tapi-topology: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.CapacityValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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.ValidationMechanismWrapper" 400: description: "Internal error" /data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/name={value-name}/: get: tags: - "tapi-topology" summary: "returns tapi.common.NameAndValue" 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." 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.NameAndValueWrapper" 400: description: "Internal error" /data/tapi-common:context/tapi-topology: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.NodeWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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.NodeEdgePointRefWrapper" 400: description: "Internal error" /data/tapi-common:context/tapi-topology: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.CapacityWrapper" 400: description: "Internal error" /data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/: get: tags: - "tapi-topology" summary: "returns tapi.common.BandwidthProfile" 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.common.BandwidthProfile" schema: $ref: "#/definitions/tapi.common.BandwidthProfileWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ : get: tags: - "tapi-topology" summary: "returns tapi.common.CapacityValue" 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.common.CapacityValue" schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ : get: tags: - "tapi-topology" summary: "returns tapi.common.CapacityValue" 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.common.CapacityValue" schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ : get: tags: - "tapi-topology" summary: "returns tapi.common.CapacityValue" 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.common.CapacityValue" schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ : get: tags: - "tapi-topology" summary: "returns tapi.common.CapacityValue" 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.common.CapacityValue" schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" 400: description: "Internal error" /data/tapi-common:context/tapi-topology: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.CapacityValueWrapper" 400: description: "Internal error" /data/tapi-common:context/tapi-topology: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.CostCharacteristicWrapper" 400: description: "Internal error" /data/tapi-common:context/tapi-topology: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.TopologyRefWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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.LatencyCharacteristicWrapper" 400: description: "Internal error" /data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/node={node-uuid}/name={value-name}/: get: tags: - "tapi-topology" summary: "returns tapi.common.NameAndValue" 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." parameters: - name: "uuid" 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.NameAndValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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.NodeRuleGroupWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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.CapacityWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/ : get: tags: - "tapi-topology" summary: "returns tapi.common.BandwidthProfile" 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.common.BandwidthProfile" schema: $ref: "#/definitions/tapi.common.BandwidthProfileWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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" summary: "returns tapi.common.CapacityValue" 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.common.CapacityValue" schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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" summary: "returns tapi.common.CapacityValue" 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.common.CapacityValue" schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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" summary: "returns tapi.common.CapacityValue" 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.common.CapacityValue" schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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" summary: "returns tapi.common.CapacityValue" 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.common.CapacityValue" schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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.CapacityValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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.CostCharacteristicWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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: "Nested NodeRuleGroups may have InterRuleGroups. The Superior NodeRuleGroup\ \ contains the nested NodeRuleGroups and their associated InterRuleGroups.\r\ \n This is equivalent to the Node-Topology hierarchy." parameters: - name: "uuid" 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.InterRuleGroupWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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: "The NodeRuleGroups that the InterRuleGroup constrains interconnection\ \ between.\r\n The CEPs of the NEPs of a referenced NodeRuleGroup\ \ can interconnect to the CEPs of the NEPs of another referenced NodeRuleGroup\ \ constrained by the rules of the 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" - 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.NodeRuleGroupRefWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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.CapacityWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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" summary: "returns tapi.common.BandwidthProfile" 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" schema: $ref: "#/definitions/tapi.common.BandwidthProfileWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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" summary: "returns tapi.common.CapacityValue" 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.CapacityValue" schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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" summary: "returns tapi.common.CapacityValue" 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.CapacityValue" schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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" summary: "returns tapi.common.CapacityValue" 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.CapacityValue" schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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" summary: "returns tapi.common.CapacityValue" 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.CapacityValue" schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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.CapacityValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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.CostCharacteristicWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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.LatencyCharacteristicWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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. 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." parameters: - name: "uuid" 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.NameAndValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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.RiskCharacteristicWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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: "The list of rules of the 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" - name: "local-id" in: "path" description: "Id of rule" required: true type: "string" responses: 200: description: "tapi.topology.Rule" schema: $ref: "#/definitions/tapi.topology.RuleWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/cep-port-role/ : get: tags: - "tapi-topology" summary: "returns tapi.topology.PortRoleRule" description: "Indicates the port role to which the rule applies. \r\n \ \ The port role is interpreted in the context of the connection type\ \ which is identified by the connection spec. \r\n The port\ \ role is not meaningful in the absence of a connection spec reference.\r\n\ \ If a node rule group carries a port role, that role applies\ \ also to the associated inter rule where the combination of the roles in\ \ the node rule groups at the ends of the inter group rule define the connection\ \ orientation.\r\n For example a root-and-leaf connection may\ \ be used in a node where a node rule group collects one set of NEPs has the\ \ port role 'root' and another node rule group collects another set of NEPs\ \ has the port role 'leaf' where these are joined by an inter rule group.\ \ This combination specifies an allowed orientation of the root-and-leaf connection.\r\ \n No port role statement means all port roles are allowed." parameters: - name: "uuid" 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.PortRoleRule" schema: $ref: "#/definitions/tapi.topology.PortRoleRuleWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/connection-spec-reference/ : get: tags: - "tapi-topology" summary: "returns tapi.topology.ConnectionSpecReference" description: "Identifies the type of connection that the rule applies to. \r\ \n If the attribute is not present then the rule applies to\ \ all types of connection supported by the device." parameters: - name: "uuid" 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.ConnectionSpecReference" schema: $ref: "#/definitions/tapi.topology.ConnectionSpecReferenceWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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. 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." parameters: - name: "uuid" 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.NameAndValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/signal-property/ : get: tags: - "tapi-topology" summary: "returns tapi.topology.SignalPropertyRule" description: "The rule only applies to signals with the properties listed. \r\ \n If the attribute is not present then the rule applies to\ \ all signals." parameters: - name: "uuid" 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.SignalPropertyRule" schema: $ref: "#/definitions/tapi.topology.SignalPropertyRuleWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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.CapacityWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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" summary: "returns tapi.common.BandwidthProfile" 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" schema: $ref: "#/definitions/tapi.common.BandwidthProfileWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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" summary: "returns tapi.common.CapacityValue" 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.CapacityValue" schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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" summary: "returns tapi.common.CapacityValue" 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.CapacityValue" schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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" summary: "returns tapi.common.CapacityValue" 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.CapacityValue" schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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" summary: "returns tapi.common.CapacityValue" 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.CapacityValue" schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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.CapacityValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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.LatencyCharacteristicWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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. 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." parameters: - name: "uuid" 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.NameAndValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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: "NEPs and their client CEPs that the rules apply to." parameters: - name: "uuid" 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.NodeEdgePointRefWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/node-rule-group={topology-uuid},{node-rule-group-node-uuid},{node-rule-group-node-rule-group-uuid}/ : get: tags: - "tapi-topology" summary: "returns tapi.topology.NodeRuleGroupRef" description: "NodeRuleGroups may be nested such that finer grained rules may\ \ be applied.\r\n A nested rule group should have a subset\ \ of the NEPs of the superior rule group." parameters: - name: "uuid" 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-rule-group" required: true type: "string" - name: "node-rule-group-node-uuid" in: "path" description: "Id of node-rule-group" required: true type: "string" - name: "node-rule-group-node-rule-group-uuid" in: "path" description: "Id of node-rule-group" required: true type: "string" responses: 200: description: "tapi.topology.NodeRuleGroupRef" schema: $ref: "#/definitions/tapi.topology.NodeRuleGroupRefWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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.RiskCharacteristicWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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: "The list of rules of the 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" - name: "local-id" in: "path" description: "Id of rule" required: true type: "string" responses: 200: description: "tapi.topology.Rule" schema: $ref: "#/definitions/tapi.topology.RuleWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/cep-port-role/ : get: tags: - "tapi-topology" summary: "returns tapi.topology.PortRoleRule" description: "Indicates the port role to which the rule applies. \r\n \ \ The port role is interpreted in the context of the connection type\ \ which is identified by the connection spec. \r\n The port\ \ role is not meaningful in the absence of a connection spec reference.\r\n\ \ If a node rule group carries a port role, that role applies\ \ also to the associated inter rule where the combination of the roles in\ \ the node rule groups at the ends of the inter group rule define the connection\ \ orientation.\r\n For example a root-and-leaf connection may\ \ be used in a node where a node rule group collects one set of NEPs has the\ \ port role 'root' and another node rule group collects another set of NEPs\ \ has the port role 'leaf' where these are joined by an inter rule group.\ \ This combination specifies an allowed orientation of the root-and-leaf connection.\r\ \n No port role statement means all port roles are allowed." parameters: - name: "uuid" 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.PortRoleRule" schema: $ref: "#/definitions/tapi.topology.PortRoleRuleWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/connection-spec-reference/ : get: tags: - "tapi-topology" summary: "returns tapi.topology.ConnectionSpecReference" description: "Identifies the type of connection that the rule applies to. \r\ \n If the attribute is not present then the rule applies to\ \ all types of connection supported by the device." parameters: - name: "uuid" 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.ConnectionSpecReference" schema: $ref: "#/definitions/tapi.topology.ConnectionSpecReferenceWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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. 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." parameters: - name: "uuid" 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.NameAndValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/signal-property/ : get: tags: - "tapi-topology" summary: "returns tapi.topology.SignalPropertyRule" description: "The rule only applies to signals with the properties listed. \r\ \n If the attribute is not present then the rule applies to\ \ all signals." parameters: - name: "uuid" 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.SignalPropertyRule" schema: $ref: "#/definitions/tapi.topology.SignalPropertyRuleWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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.CapacityWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/ : get: tags: - "tapi-topology" summary: "returns tapi.common.BandwidthProfile" 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.common.BandwidthProfile" schema: $ref: "#/definitions/tapi.common.BandwidthProfileWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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" summary: "returns tapi.common.CapacityValue" 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.common.CapacityValue" schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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" summary: "returns tapi.common.CapacityValue" 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.common.CapacityValue" schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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" summary: "returns tapi.common.CapacityValue" 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.common.CapacityValue" schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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" summary: "returns tapi.common.CapacityValue" 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.common.CapacityValue" schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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.CapacityValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/ : get: tags: - "tapi-topology" summary: "returns tapi.topology.node.OwnedNodeEdgePoint" 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: "owned-node-edge-point-uuid" in: "path" description: "Id of owned-node-edge-point" required: true type: "string" responses: 200: description: "tapi.topology.node.OwnedNodeEdgePoint" schema: $ref: "#/definitions/tapi.topology.node.OwnedNodeEdgePointWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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" 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: "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.NodeEdgePointRefWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-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: "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.CapacityWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/ : get: tags: - "tapi-topology" summary: "returns tapi.common.BandwidthProfile" 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: "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.BandwidthProfileWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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" summary: "returns tapi.common.CapacityValue" 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: "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.CapacityValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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" summary: "returns tapi.common.CapacityValue" 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: "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.CapacityValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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" summary: "returns tapi.common.CapacityValue" 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: "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.CapacityValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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" summary: "returns tapi.common.CapacityValue" 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: "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.CapacityValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-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: "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.CapacityValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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" 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: "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.ServiceInterfacePointRefWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/name={value-name}/ : get: tags: - "tapi-topology" summary: "returns tapi.common.NameAndValue" 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." parameters: - name: "uuid" 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.NameAndValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/tapi-connectivity:cep-list/ : get: tags: - "tapi-connectivity" summary: "returns tapi.connectivity.CepList" 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: "owned-node-edge-point-uuid" in: "path" description: "Id of owned-node-edge-point" required: true type: "string" responses: 200: description: "tapi.connectivity.CepList" schema: $ref: "#/definitions/tapi.connectivity.CepListWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/tapi-connectivity:cep-list/connection-end-point={connection-end-point-uuid}/ : get: tags: - "tapi-connectivity" summary: "returns tapi.connectivity.ConnectionEndPoint" 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: "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.connectivity.ConnectionEndPoint" schema: $ref: "#/definitions/tapi.connectivity.ConnectionEndPointWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/tapi-connectivity: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}/ : get: tags: - "tapi-connectivity" summary: "returns tapi.connectivity.ConnectionEndPointRef" 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: "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" required: true type: "string" responses: 200: description: "tapi.connectivity.ConnectionEndPointRef" schema: $ref: "#/definitions/tapi.connectivity.ConnectionEndPointRefWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/tapi-connectivity:cep-list/connection-end-point={connection-end-point-uuid}/cep-role/ : get: tags: - "tapi-connectivity" summary: "returns tapi.connectivity.CepRole" description: "Defines the role of the CEP in the context of the connection spec.\r\ \n There may be many cep role - connection spec combinations\ \ for a particular CEP where each corresponds to a specific connection associated\ \ with the CEP." parameters: - name: "uuid" 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.connectivity.CepRole" schema: $ref: "#/definitions/tapi.connectivity.CepRoleWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/tapi-connectivity:cep-list/connection-end-point={connection-end-point-uuid}/cep-role/connection-spec-reference/ : get: tags: - "tapi-connectivity" summary: "returns tapi.connectivity.ConnectionSpecReference" description: "The reference to the spec that defines the cep role." parameters: - name: "uuid" 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.connectivity.ConnectionSpecReference" schema: $ref: "#/definitions/tapi.connectivity.ConnectionSpecReferenceWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/tapi-connectivity: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}/ : get: tags: - "tapi-connectivity" 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: "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" required: true type: "string" responses: 200: description: "tapi.topology.NodeEdgePointRef" schema: $ref: "#/definitions/tapi.topology.NodeEdgePointRefWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/tapi-connectivity:cep-list/connection-end-point={connection-end-point-uuid}/name={value-name}/ : get: tags: - "tapi-connectivity" summary: "returns tapi.common.NameAndValue" 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." parameters: - name: "uuid" 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.NameAndValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/tapi-connectivity:cep-list/connection-end-point={connection-end-point-uuid}/parent-node-edge-point/ : get: tags: - "tapi-connectivity" 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: "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.NodeEdgePointRefWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-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: "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.CapacityWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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" summary: "returns tapi.common.BandwidthProfile" 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: "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.BandwidthProfileWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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" summary: "returns tapi.common.CapacityValue" 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: "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.CapacityValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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" summary: "returns tapi.common.CapacityValue" 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: "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.CapacityValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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" summary: "returns tapi.common.CapacityValue" 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: "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.CapacityValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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" summary: "returns tapi.common.CapacityValue" 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: "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.CapacityValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology: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" 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: "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.CapacityValueWrapper" 400: description: "Internal error" /data/tapi-common:context/tapi-topology: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.CapacityWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/ : get: tags: - "tapi-topology" summary: "returns tapi.common.BandwidthProfile" 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.common.BandwidthProfile" schema: $ref: "#/definitions/tapi.common.BandwidthProfileWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ : get: tags: - "tapi-topology" summary: "returns tapi.common.CapacityValue" 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.common.CapacityValue" schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ : get: tags: - "tapi-topology" summary: "returns tapi.common.CapacityValue" 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.common.CapacityValue" schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ : get: tags: - "tapi-topology" summary: "returns tapi.common.CapacityValue" 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.common.CapacityValue" schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" 400: description: "Internal error" ? /data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ : get: tags: - "tapi-topology" summary: "returns tapi.common.CapacityValue" 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.common.CapacityValue" schema: $ref: "#/definitions/tapi.common.CapacityValueWrapper" 400: description: "Internal error" /data/tapi-common:context/tapi-topology: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.CapacityValueWrapper" 400: description: "Internal error" /operations/tapi-common: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/tapi-common: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/tapi-common: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" /operations/tapi-connectivity:create-connectivity-service/: 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" 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/tapi-connectivity:delete-connectivity-service/: 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" required: false schema: properties: input: $ref: "#/definitions/tapi.connectivity.deleteconnectivityservice.Input" responses: 201: description: "No response" 400: description: "Internal error" /operations/tapi-connectivity:get-connection-details/: 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" required: false schema: properties: input: $ref: "#/definitions/tapi.connectivity.getconnectiondetails.Input" responses: 200: description: "Correct response" schema: $ref: "#/definitions/tapi.connectivity.GetConnectionDetails" 201: description: "No response" 400: description: "Internal error" /operations/tapi-connectivity:get-connection-end-point-details/: 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" required: false schema: properties: input: $ref: "#/definitions/tapi.connectivity.getconnectionendpointdetails.Input" responses: 200: description: "Correct response" schema: $ref: "#/definitions/tapi.connectivity.GetConnectionEndPointDetails" 201: description: "No response" 400: description: "Internal error" /operations/tapi-connectivity:get-connectivity-service-details/: 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" required: false schema: properties: input: $ref: "#/definitions/tapi.connectivity.getconnectivityservicedetails.Input" responses: 200: description: "Correct response" schema: $ref: "#/definitions/tapi.connectivity.GetConnectivityServiceDetails" 201: description: "No response" 400: description: "Internal error" /operations/tapi-connectivity:get-connectivity-service-list/: post: tags: - "tapi-connectivity" parameters: [] responses: 200: description: "Correct response" schema: $ref: "#/definitions/tapi.connectivity.GetConnectivityServiceList" 201: description: "No response" 400: description: "Internal error" /operations/tapi-connectivity:update-connectivity-service/: 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" required: false schema: properties: input: $ref: "#/definitions/tapi.connectivity.updateconnectivityservice.Input" responses: 200: description: "Correct response" schema: $ref: "#/definitions/tapi.connectivity.UpdateConnectivityService" 201: description: "No response" 400: description: "Internal error" /operations/tapi-notification: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/tapi-notification: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: 200: description: "Correct response" schema: $ref: "#/definitions/tapi.notification.DeleteNotificationSubscriptionService" 201: description: "No response" 400: description: "Internal error" /operations/tapi-notification: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/tapi-notification: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/tapi-notification: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/tapi-notification: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/tapi-notification: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/tapi-path-computation:compute-p-2-p-path/: 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" 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/tapi-path-computation:delete-p-2-p-path/: 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" required: false schema: properties: input: $ref: "#/definitions/tapi.path.computation.deletep2ppath.Input" responses: 200: description: "Correct response" schema: $ref: "#/definitions/tapi.path.computation.DeleteP2PPath" 201: description: "No response" 400: description: "Internal error" /operations/tapi-path-computation:optimize-p-2-ppath/: 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" required: false schema: properties: input: $ref: "#/definitions/tapi.path.computation.optimizep2ppath.Input" responses: 200: description: "Correct response" schema: $ref: "#/definitions/tapi.path.computation.OptimizeP2Ppath" 201: description: "No response" 400: description: "Internal error" /operations/tapi-topology: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/tapi-topology: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/tapi-topology: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/tapi-topology: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/tapi-topology: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" 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.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.BandwidthProfileWrapper: properties: bandwidth-profile: $ref: "#/definitions/tapi.common.BandwidthProfile" 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." $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.CapacityValueWrapper: properties: committed-burst-size: $ref: "#/definitions/tapi.common.CapacityValue" tapi.common.CapacityWrapper: properties: available-capacity: $ref: "#/definitions/tapi.common.Capacity" tapi.common.Context: allOf: - $ref: "#/definitions/tapi.common.TapiContext" - $ref: "#/definitions/tapi.connectivity.ContextAugmentation3" - $ref: "#/definitions/tapi.notification.ContextAugmentation1" - $ref: "#/definitions/tapi.path.computation.ContextAugmentation2" - $ref: "#/definitions/tapi.topology.ContextAugmentation4" tapi.common.ContextWrapper: properties: tapi-common:context: $ref: "#/definitions/tapi.common.Context" tapi.common.DirectiveValue: type: "string" enum: - "MINIMIZE" - "MAXIMIZE" - "ALLOW" - "DISALLOW" - "DONT_CARE" 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. 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." 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" 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. 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." 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.NameAndValueWrapper: properties: name: $ref: "#/definitions/tapi.common.NameAndValue" tapi.common.OperationalState: type: "string" enum: - "DISABLED" - "ENABLED" tapi.common.OperationalStatePac: type: "object" properties: operational-state: description: "none" $ref: "#/definitions/tapi.common.OperationalState" lifecycle-state: description: "none" $ref: "#/definitions/tapi.common.LifecycleState" 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" direction: description: "If direction attribute is missing the SIP instance is to be\ \ intended as 'BIDIRECTIONAL'" $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.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.ServiceInterfacePointRefWrapper: properties: service-interface-point: $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" tapi.common.ServiceInterfacePointWrapper: properties: service-interface-point: $ref: "#/definitions/tapi.common.ServiceInterfacePoint" 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.TimeRangeWrapper: properties: schedule: $ref: "#/definitions/tapi.common.TimeRange" tapi.common.getserviceinterfacepointdetails.Input: type: "object" properties: sip-id-or-name: type: "string" description: "none" 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: sip-id-or-name: type: "string" description: "none" state: description: "none" $ref: "#/definitions/tapi.common.AdministrativeState" tapi.connectivity.CepList: type: "object" properties: connection-end-point: type: "array" description: "none" items: $ref: "#/definitions/tapi.connectivity.ConnectionEndPoint" tapi.connectivity.CepListWrapper: properties: tapi-connectivity:cep-list: $ref: "#/definitions/tapi.connectivity.CepList" tapi.connectivity.CepRole: type: "object" properties: role-name: type: "string" description: "The name of the cep role in the context of the referenced spec." connection-spec-reference: description: "The reference to the spec that defines the cep role." $ref: "#/definitions/tapi.connectivity.ConnectionSpecReference" tapi.connectivity.CepRoleWrapper: properties: cep-role: $ref: "#/definitions/tapi.connectivity.CepRole" tapi.connectivity.Connection: allOf: - $ref: "#/definitions/tapi.common.GlobalClass" - $ref: "#/definitions/tapi.common.OperationalStatePac" - type: "object" properties: supported-client-link: type: "array" description: "none" items: $ref: "#/definitions/tapi.topology.LinkRef" lower-connection: type: "array" 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." items: $ref: "#/definitions/tapi.connectivity.ConnectionRef" switch-control: type: "array" description: "none" items: $ref: "#/definitions/tapi.connectivity.SwitchControl" route: type: "array" description: "none" items: $ref: "#/definitions/tapi.connectivity.Route" connection-spec-reference: description: "Provides the reference to the spec that defines the connection\ \ type and cepRoles." $ref: "#/definitions/tapi.connectivity.ConnectionSpecReference" layer-protocol-name: description: "none" $ref: "#/definitions/tapi.common.LayerProtocolName" connection-end-point: type: "array" description: "none" items: $ref: "#/definitions/tapi.connectivity.ConnectionEndPointRef" 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." tapi.connectivity.ConnectionEndPoint: allOf: - $ref: "#/definitions/tapi.common.GlobalClass" - $ref: "#/definitions/tapi.common.OperationalStatePac" - $ref: "#/definitions/tapi.common.TerminationPac" - type: "object" properties: client-node-edge-point: type: "array" description: "none" items: $ref: "#/definitions/tapi.topology.NodeEdgePointRef" connection-port-role: description: "Each EP of the FC has a role (e.g., working, protection, protected,\ \ symmetric, hub, spoke, leaf, root) in the context of the FC with respect\ \ to the FC function. " $ref: "#/definitions/tapi.common.PortRole" layer-protocol-name: description: "none" $ref: "#/definitions/tapi.common.LayerProtocolName" layer-protocol-qualifier: type: "string" description: "none" parent-node-edge-point: description: "none" $ref: "#/definitions/tapi.topology.NodeEdgePointRef" cep-role: type: "array" description: "Defines the role of the CEP in the context of the connection\ \ spec.\r\n There may be many cep role - connection spec\ \ combinations for a particular CEP where each corresponds to a specific\ \ connection associated with the CEP." items: $ref: "#/definitions/tapi.connectivity.CepRole" aggregated-connection-end-point: type: "array" description: "none" items: $ref: "#/definitions/tapi.connectivity.ConnectionEndPointRef" connection-port-direction: description: "The orientation of defined flow at the EndPoint." $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.connectivity.ConnectionEndPointRef: allOf: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - type: "object" properties: 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" description: "none" tapi.connectivity.ConnectionEndPointRefWrapper: properties: connection-end-point: $ref: "#/definitions/tapi.connectivity.ConnectionEndPointRef" tapi.connectivity.ConnectionEndPointWrapper: properties: connection-end-point: $ref: "#/definitions/tapi.connectivity.ConnectionEndPoint" tapi.connectivity.ConnectionRef: type: "object" properties: connection-uuid: type: "string" description: "none" x-path: "/tapi-common:context/tapi-connectivity:connectivity-context/tapi-connectivity:connection/tapi-connectivity:uuid" tapi.connectivity.ConnectionRefWrapper: properties: lower-connection: $ref: "#/definitions/tapi.connectivity.ConnectionRef" tapi.connectivity.ConnectionSpecReference: type: "object" properties: connection-spec-name: type: "string" description: "The name of the connection spec.\r\n This can\ \ be used alone (with no spec reference) where there is only a paper spec." connection-spec-id: type: "string" description: "The reference to a formal spec. \r\n This reference\ \ need not be provided (e.g., where there is no formal machine interpretable\ \ spec for the type of connection)." tapi.connectivity.ConnectionSpecReferenceWrapper: properties: connection-spec-reference: $ref: "#/definitions/tapi.connectivity.ConnectionSpecReference" tapi.connectivity.ConnectionWrapper: properties: connection: $ref: "#/definitions/tapi.connectivity.Connection" 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" diversity-exclusion: type: "array" description: "none" items: $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" connection-inclusion: type: "array" description: "A ConnectivityService may use one or more existing Connections.\r\ \n A common traditional strategy is to set up “stranded”\ \ connectivity in the core of the network as “express channels” (this is\ \ essentially a serial compound link, but can be treated as simple connections)\r\ \n A connection inclusion capability allows for adoption\ \ of a discovered Connections.\r\n A ConnectivityService\ \ is requested with a connection inclusion constraint that identifies a\ \ connection (or chain of connections) that is bounded by CEPs that each\ \ belong to a NEP that references a SIP that is referenced by a CSEP of\ \ the ConnectivityService such that all CSEPs are satisfied by CEPs of the\ \ existing Connection. will allow discovered Connections with no stated\ \ intent to be associated with an intent via the ConnectivityService." items: type: "string" service-level: type: "string" description: "An abstract value the meaning of which is mutually agreed –\ \ typically represents metrics such as - Class of service, priority, resiliency,\ \ availability" service-type: description: "none" $ref: "#/definitions/tapi.connectivity.ServiceType" connection-exclusion: type: "array" description: "none" items: type: "string" 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.ConnectivityContextWrapper: properties: tapi-connectivity:connectivity-context: $ref: "#/definitions/tapi.connectivity.ConnectivityContext" 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" - $ref: "#/definitions/tapi.common.LocalClass" - type: "object" properties: protection-role: description: "To specify the protection role of this Port when create or\ \ update ConnectivityService." $ref: "#/definitions/tapi.connectivity.ProtectionRole" role: description: "Each EP of the FC has a role (e.g., working, protection, protected,\ \ symmetric, hub, spoke, leaf, root) in the context of the FC with respect\ \ to the FC function. " $ref: "#/definitions/tapi.common.PortRole" 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" layer-protocol-qualifier: type: "string" description: "none" connection-end-point: type: "array" description: "none" items: $ref: "#/definitions/tapi.connectivity.ConnectionEndPointRef" server-connectivity-service-end-point: description: "none" $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" protecting-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" 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" 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.ConnectivityServiceEndPointRefWrapper: properties: peer-fwd-connectivity-service-end-point: $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" tapi.connectivity.ConnectivityServiceEndPointWrapper: properties: end-point: $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" tapi.connectivity.ConnectivityServiceRef: type: "object" properties: connectivity-service-uuid: type: "string" description: "none" x-path: "/tapi-common:context/tapi-connectivity:connectivity-context/tapi-connectivity:connectivity-service/tapi-connectivity:uuid" tapi.connectivity.ConnectivityServiceRefWrapper: properties: coroute-inclusion: $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" tapi.connectivity.ConnectivityServiceWrapper: properties: connectivity-service: $ref: "#/definitions/tapi.connectivity.ConnectivityService" tapi.connectivity.ContextAugmentation3: type: "object" properties: connectivity-context: description: "Augments the base TAPI Context with ConnectivityService information" $ref: "#/definitions/tapi.connectivity.ConnectivityContext" x-augmentation: prefix: "tapi-connectivity" namespace: "urn:onf:otcc:yang:tapi-connectivity" tapi.connectivity.CoordinateType: type: "string" enum: - "NO_COORDINATE" - "HOLD_OFF_TIME" - "WAIT_FOR_NOTIFICATION" tapi.connectivity.CreateConnectivityService: type: "object" properties: output: $ref: "#/definitions/tapi.connectivity.createconnectivityservice.Output" tapi.connectivity.GetConnectionDetails: type: "object" properties: output: $ref: "#/definitions/tapi.connectivity.getconnectiondetails.Output" tapi.connectivity.GetConnectionEndPointDetails: type: "object" properties: output: $ref: "#/definitions/tapi.connectivity.getconnectionendpointdetails.Output" tapi.connectivity.GetConnectivityServiceDetails: type: "object" properties: output: $ref: "#/definitions/tapi.connectivity.getconnectivityservicedetails.Output" tapi.connectivity.GetConnectivityServiceList: type: "object" properties: output: $ref: "#/definitions/tapi.connectivity.getconnectivityservicelist.Output" tapi.connectivity.OwnedNodeEdgePointAugmentation1: type: "object" properties: cep-list: description: "none" $ref: "#/definitions/tapi.connectivity.CepList" x-augmentation: prefix: "tapi-connectivity" namespace: "urn:onf:otcc:yang:tapi-connectivity" tapi.connectivity.ProtectionRole: type: "string" enum: - "WORK" - "PROTECT" - "PROTECTED" - "NA" - "WORK_RESTORE" - "PROTECT_RESTORE" tapi.connectivity.ResilienceConstraint: type: "object" properties: 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." 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 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" description: "If the protection system is revertive, this attribute specifies\ \ 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" preferred-restoration-layer: type: "array" description: "Indicate which layer this resilience parameters package configured\ \ for." items: $ref: "#/definitions/tapi.common.LayerProtocolName" restore-priority: type: "integer" format: "int32" description: "none" reversion-mode: description: "Indcates whether the protection scheme is revertive or non-revertive." $ref: "#/definitions/tapi.connectivity.ReversionMode" tapi.connectivity.ResilienceRoute: allOf: - $ref: "#/definitions/tapi.common.LocalClass" - type: "object" properties: priority: type: "integer" format: "int32" description: "Value of 0 (zero) means 'unspecified priority'.\r\n \ \ Highest priority is 1, sometimes referred as 'preferred' or\ \ 'main' or 'intended' route.\r\n 2 has lower priority\ \ than 1, 3 has lower priority than 2, etc." route-state: type: "string" description: "Current information on the route selection." description: "This object adds resilience and state attributes to the Route.\r\ \n When this object is not present, then the Route is intendend\ \ as 'current' Route of the Connection." tapi.connectivity.ResilienceRouteWrapper: properties: resilience-route-pac: $ref: "#/definitions/tapi.connectivity.ResilienceRoute" tapi.connectivity.ReversionMode: type: "string" enum: - "REVERTIVE" - "NON-REVERTIVE" tapi.connectivity.Route: allOf: - $ref: "#/definitions/tapi.common.LocalClass" - type: "object" properties: connection-end-point: type: "array" description: "none" items: $ref: "#/definitions/tapi.connectivity.ConnectionEndPointRef" resilience-route-pac: description: "Provides optional resilience and state attributes to the Route." $ref: "#/definitions/tapi.connectivity.ResilienceRoute" description: "The Route of a Connection is modeled as a collection of Connection\ \ End Points.\r\n The logical order of the Connection End Points\ \ within the Route object can be inferred by the TAPI client by the knowledge\ \ of the Topology information." tapi.connectivity.RouteRef: allOf: - $ref: "#/definitions/tapi.connectivity.ConnectionRef" - type: "object" properties: route-local-id: type: "string" description: "none" x-path: "/tapi-common:context/tapi-connectivity:connectivity-context/tapi-connectivity:connection/tapi-connectivity:route/tapi-connectivity:local-id" description: "none" tapi.connectivity.RouteRefWrapper: properties: selected-route: $ref: "#/definitions/tapi.connectivity.RouteRef" tapi.connectivity.RouteWrapper: properties: route: $ref: "#/definitions/tapi.connectivity.Route" tapi.connectivity.SelectionControl: type: "string" enum: - "LOCK_OUT" - "NORMAL" - "MANUAL" - "FORCED" tapi.connectivity.SelectionReason: type: "string" enum: - "LOCKOUT" - "NORMAL" - "MANUAL" - "FORCED" - "WAIT_TO_REVERT" - "SIGNAL_DEGRADE" - "SIGNAL_FAIL" tapi.connectivity.ServiceType: type: "string" enum: - "POINT_TO_POINT_CONNECTIVITY" - "POINT_TO_MULTIPOINT_CONNECTIVITY" - "MULTIPOINT_CONNECTIVITY" - "ROOTED_MULTIPOINT_CONNECTIVITY" tapi.connectivity.Switch: allOf: - $ref: "#/definitions/tapi.common.LocalClass" - type: "object" properties: selected-connection-end-point: type: "array" description: "none" items: $ref: "#/definitions/tapi.connectivity.ConnectionEndPointRef" selected-route: type: "array" 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" switch-direction: description: "Indicates whether the switch selects from ingress to the FC\ \ or to egress of the FC, or both." $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." tapi.connectivity.SwitchControl: allOf: - $ref: "#/definitions/tapi.common.GlobalClass" - $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" - type: "object" properties: sub-switch-control: type: "array" description: "none" items: $ref: "#/definitions/tapi.connectivity.SwitchControlRef" switch: type: "array" description: "none" items: $ref: "#/definitions/tapi.connectivity.Switch" description: "Represents the capability to control and coordinate switches,\ \ to add/delete/modify FCs and to add/delete/modify LTPs/LPs so as to realize\ \ a protection scheme." tapi.connectivity.SwitchControlRef: allOf: - $ref: "#/definitions/tapi.connectivity.ConnectionRef" - type: "object" properties: switch-control-uuid: type: "string" description: "none" x-path: "/tapi-common:context/tapi-connectivity:connectivity-context/tapi-connectivity:connection/tapi-connectivity:switch-control/tapi-connectivity:uuid" description: "none" tapi.connectivity.SwitchControlRefWrapper: properties: sub-switch-control: $ref: "#/definitions/tapi.connectivity.SwitchControlRef" tapi.connectivity.SwitchControlWrapper: properties: switch-control: $ref: "#/definitions/tapi.connectivity.SwitchControl" tapi.connectivity.SwitchWrapper: properties: switch: $ref: "#/definitions/tapi.connectivity.Switch" tapi.connectivity.UpdateConnectivityService: type: "object" properties: output: $ref: "#/definitions/tapi.connectivity.updateconnectivityservice.Output" tapi.connectivity.createconnectivityservice.Input: type: "object" properties: topology-constraint: description: "none" $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" routing-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.RoutingConstraint" state: type: "string" description: "none" connectivity-constraint: description: "none" $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" tapi.connectivity.createconnectivityservice.Output: type: "object" properties: service: description: "none" $ref: "#/definitions/tapi.connectivity.ConnectivityService" tapi.connectivity.deleteconnectivityservice.Input: type: "object" properties: service-id-or-name: type: "string" description: "none" tapi.connectivity.getconnectiondetails.Input: type: "object" properties: connection-id-or-name: type: "string" description: "none" tapi.connectivity.getconnectiondetails.Output: type: "object" properties: connection: description: "none" $ref: "#/definitions/tapi.connectivity.Connection" 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: type: "string" description: "none" tapi.connectivity.getconnectionendpointdetails.Output: type: "object" properties: connection-end-point: description: "none" $ref: "#/definitions/tapi.connectivity.ConnectionEndPoint" tapi.connectivity.getconnectivityservicedetails.Input: type: "object" properties: service-id-or-name: type: "string" description: "none" tapi.connectivity.getconnectivityservicedetails.Output: type: "object" properties: service: description: "none" $ref: "#/definitions/tapi.connectivity.ConnectivityService" tapi.connectivity.getconnectivityservicelist.Output: type: "object" properties: service: type: "array" description: "none" items: $ref: "#/definitions/tapi.connectivity.ConnectivityService" tapi.connectivity.updateconnectivityservice.Input: type: "object" properties: service-id-or-name: type: "string" description: "none" topology-constraint: description: "none" $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" routing-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.RoutingConstraint" state: type: "string" description: "none" connectivity-constraint: description: "none" $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" 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.AlarmInfoWrapper: properties: alarm-info: $ref: "#/definitions/tapi.notification.AlarmInfo" 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.DeleteNotificationSubscriptionService: type: "object" properties: output: $ref: "#/definitions/tapi.notification.deletenotificationsubscriptionservice.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.NameAndValueChangeWrapper: properties: changed-attributes: $ref: "#/definitions/tapi.notification.NameAndValueChange" tapi.notification.Notification: allOf: - $ref: "#/definitions/tapi.common.GlobalClass" - type: "object" properties: target-object-type: description: "none" $ref: "#/definitions/tapi.notification.ObjectType" 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." tca-info: description: "none" $ref: "#/definitions/tapi.notification.TcaInfo" target-object-identifier: type: "string" description: "none" notification-type: description: "none" $ref: "#/definitions/tapi.notification.NotificationType" 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" alarm-info: description: "none" $ref: "#/definitions/tapi.notification.AlarmInfo" 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.NotificationChannelWrapper: properties: notification-channel: $ref: "#/definitions/tapi.notification.NotificationChannel" 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.NotificationContextWrapper: properties: tapi-notification:notification-context: $ref: "#/definitions/tapi.notification.NotificationContext" 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: $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.NotificationSubscriptionServiceWrapper: properties: notif-subscription: $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" tapi.notification.NotificationType: type: "string" enum: - "OBJECT_CREATION" - "OBJECT_DELETION" - "ATTRIBUTE_VALUE_CHANGE" - "ALARM_EVENT" - "THRESHOLD_CROSSING_ALERT" tapi.notification.NotificationWrapper: properties: notification: $ref: "#/definitions/tapi.notification.Notification" 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" - "ACCESS_PORT" - "EQUIPMENT" - "HOLDER" - "PHYSICAL_SPAN" - "ABSTRACT_STRAND" - "DEVICE" 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: - "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: $ref: "#/definitions/tapi.notification.NotificationType" 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: $ref: "#/definitions/tapi.notification.ObjectType" description: "none" tapi.notification.SubscriptionFilterWrapper: properties: subscription-filter: $ref: "#/definitions/tapi.notification.SubscriptionFilter" 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.TcaInfoWrapper: properties: tca-info: $ref: "#/definitions/tapi.notification.TcaInfo" 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.createnotificationsubscriptionservice.Input: type: "object" properties: subscription-state: description: "none" $ref: "#/definitions/tapi.notification.SubscriptionState" 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: subscription-id-or-name: type: "string" description: "none" tapi.notification.deletenotificationsubscriptionservice.Output: type: "object" properties: subscription-service: description: "none" $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" tapi.notification.getnotificationlist.Input: type: "object" properties: time-period: type: "string" description: "none" subscription-id-or-name: type: "string" description: "none" 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: subscription-id-or-name: type: "string" description: "none" 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: $ref: "#/definitions/tapi.notification.ObjectType" supported-notification-types: type: "array" description: "none" items: $ref: "#/definitions/tapi.notification.NotificationType" tapi.notification.updatenotificationsubscriptionservice.Input: type: "object" properties: subscription-state: description: "none" $ref: "#/definitions/tapi.notification.SubscriptionState" 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.path.computation.ComputeP2PPath: type: "object" properties: output: $ref: "#/definitions/tapi.path.computation.computep2ppath.Output" tapi.path.computation.ContextAugmentation2: type: "object" properties: path-computation-context: description: "Augments the base TAPI Context with PathComputationService information" $ref: "#/definitions/tapi.path.computation.PathComputationContext" x-augmentation: prefix: "tapi-path-computation" namespace: "urn:onf:otcc:yang:tapi-path-computation" tapi.path.computation.DeleteP2PPath: type: "object" properties: output: $ref: "#/definitions/tapi.path.computation.deletep2ppath.Output" tapi.path.computation.DiversityPolicy: type: "string" enum: - "SRLG" - "SRNG" - "SNG" - "NODE" - "LINK" tapi.path.computation.OptimizeP2Ppath: type: "object" properties: output: $ref: "#/definitions/tapi.path.computation.optimizep2ppath.Output" tapi.path.computation.Path: allOf: - $ref: "#/definitions/tapi.common.GlobalClass" - type: "object" properties: layer-protocol-name: description: "none" $ref: "#/definitions/tapi.common.LayerProtocolName" link: type: "array" description: "none" items: $ref: "#/definitions/tapi.topology.LinkRef" routing-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.RoutingConstraint" direction: description: "none" $ref: "#/definitions/tapi.common.ForwardingDirection" description: "Path is described by an ordered list of TE Links. A TE Link is\ \ defined by a pair of Node/NodeEdgePoint IDs. A Connection is realized by\ \ concatenating link resources (associated with a Link) and the lower-level\ \ connections (cross-connections) in the different nodes" tapi.path.computation.PathComputationContext: type: "object" properties: path-comp-service: type: "array" description: "none" items: $ref: "#/definitions/tapi.path.computation.PathComputationService" path: type: "array" description: "none" items: $ref: "#/definitions/tapi.path.computation.Path" tapi.path.computation.PathComputationContextWrapper: properties: tapi-path-computation:path-computation-context: $ref: "#/definitions/tapi.path.computation.PathComputationContext" tapi.path.computation.PathComputationService: allOf: - $ref: "#/definitions/tapi.common.GlobalClass" - type: "object" properties: topology-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.TopologyConstraint" path: type: "array" description: "none" items: $ref: "#/definitions/tapi.path.computation.PathRef" objective-function: description: "none" $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" end-point: type: "array" description: "none" items: $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" routing-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.RoutingConstraint" optimization-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" description: "none" tapi.path.computation.PathComputationServiceWrapper: properties: path-comp-service: $ref: "#/definitions/tapi.path.computation.PathComputationService" tapi.path.computation.PathObjectiveFunction: allOf: - $ref: "#/definitions/tapi.common.LocalClass" - type: "object" properties: link-utilization: description: "none" $ref: "#/definitions/tapi.common.DirectiveValue" bandwidth-optimization: description: "none" $ref: "#/definitions/tapi.common.DirectiveValue" cost-optimization: description: "none" $ref: "#/definitions/tapi.common.DirectiveValue" resource-sharing: description: "none" $ref: "#/definitions/tapi.common.DirectiveValue" concurrent-paths: description: "none" $ref: "#/definitions/tapi.common.DirectiveValue" description: "none" tapi.path.computation.PathObjectiveFunctionWrapper: properties: objective-function: $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" tapi.path.computation.PathOptimizationConstraint: allOf: - $ref: "#/definitions/tapi.common.LocalClass" - type: "object" properties: traffic-interruption: description: "none" $ref: "#/definitions/tapi.common.DirectiveValue" description: "none" tapi.path.computation.PathOptimizationConstraintWrapper: properties: optimization-constraint: $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" tapi.path.computation.PathRef: type: "object" properties: path-uuid: type: "string" description: "none" x-path: "/tapi-common:context/tapi-path-computation:path-computation-context/tapi-path-computation:path/tapi-path-computation:uuid" tapi.path.computation.PathRefWrapper: properties: path: $ref: "#/definitions/tapi.path.computation.PathRef" tapi.path.computation.PathServiceEndPoint: allOf: - $ref: "#/definitions/tapi.common.LocalClass" - type: "object" properties: role: description: "Each EP of the FC has a role (e.g., working, protection, protected,\ \ symmetric, hub, spoke, leaf, root) in the context of the FC with respect\ \ to the FC function. " $ref: "#/definitions/tapi.common.PortRole" service-interface-point: description: "none" $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" layer-protocol-name: description: "none" $ref: "#/definitions/tapi.common.LayerProtocolName" layer-protocol-qualifier: type: "string" description: "none" direction: description: "The orientation of defined flow at the EndPoint." $ref: "#/definitions/tapi.common.PortDirection" capacity: 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" tapi.path.computation.PathServiceEndPointWrapper: properties: end-point: $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" tapi.path.computation.PathWrapper: properties: path: $ref: "#/definitions/tapi.path.computation.Path" tapi.path.computation.RouteObjectiveFunction: type: "string" enum: - "MIN_WORK_ROUTE_HOP" - "MIN_WORK_ROUTE_COST" - "MIN_WORK_ROUTE_LATENCY" - "MIN_SUM_OF_WORK_AND_PROTECTION_ROUTE_HOP" - "MIN_SUM_OF_WORK_AND_PROTECTION_ROUTE_COST" - "MIN_SUM_OF_WORK_AND_PROTECTION_ROUTE_LATENCY" - "LOAD_BALANCE_MAX_UNUSED_CAPACITY" tapi.path.computation.RoutingConstraint: type: "object" properties: is-exclusive: type: "boolean" description: "To distinguish if the resources are to be exclusive to the service" default: true max-allowed-cost: description: "none" $ref: "#/definitions/tapi.path.computation.ValueOrPriority" diversity-policy: description: "none" $ref: "#/definitions/tapi.path.computation.DiversityPolicy" route-objective-function: description: "none" $ref: "#/definitions/tapi.path.computation.RouteObjectiveFunction" 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" max-allowed-hops: description: "none" $ref: "#/definitions/tapi.path.computation.ValueOrPriority" max-allowed-delay: description: "Delay unit is microseconds." $ref: "#/definitions/tapi.path.computation.ValueOrPriority" 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" risk-diversity-characteristic: type: "array" description: "none" items: $ref: "#/definitions/tapi.topology.RiskCharacteristic" route-direction: description: "none" $ref: "#/definitions/tapi.common.ForwardingDirection" tapi.path.computation.RoutingConstraintWrapper: properties: routing-constraint: $ref: "#/definitions/tapi.path.computation.RoutingConstraint" 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: type: "string" exclude-link: type: "array" description: "none" items: type: "string" avoid-topology: type: "array" description: "none" items: type: "string" exclude-path: type: "array" description: "none" items: type: "string" include-link: type: "array" description: "This is a loose constraint - that is it is unordered and could\ \ be a partial list " items: type: "string" 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: $ref: "#/definitions/tapi.common.LayerProtocolName" exclude-node: type: "array" description: "none" items: type: "string" include-topology: type: "array" description: "none" items: type: "string" include-path: type: "array" description: "none" items: type: "string" tapi.path.computation.TopologyConstraintWrapper: properties: topology-constraint: $ref: "#/definitions/tapi.path.computation.TopologyConstraint" tapi.path.computation.ValueOrPriority: type: "object" properties: priority: type: "integer" format: "int32" description: "none" value: type: "integer" format: "int32" description: "none" tapi.path.computation.ValueOrPriorityWrapper: properties: max-allowed-cost: $ref: "#/definitions/tapi.path.computation.ValueOrPriority" tapi.path.computation.computep2ppath.Input: type: "object" properties: topology-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.TopologyConstraint" routing-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.RoutingConstraint" objective-function: description: "none" $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" sep: type: "array" description: "none" items: $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" tapi.path.computation.computep2ppath.Output: type: "object" properties: service: description: "none" $ref: "#/definitions/tapi.path.computation.PathComputationService" tapi.path.computation.deletep2ppath.Input: type: "object" properties: path-id-or-name: type: "string" description: "none" tapi.path.computation.deletep2ppath.Output: type: "object" properties: service: description: "none" $ref: "#/definitions/tapi.path.computation.PathComputationService" tapi.path.computation.optimizep2ppath.Input: type: "object" properties: 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" objective-function: description: "none" $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" tapi.path.computation.optimizep2ppath.Output: type: "object" properties: service: description: "none" $ref: "#/definitions/tapi.path.computation.PathComputationService" tapi.topology.ConnectionSpecReference: type: "object" properties: connection-spec-name: type: "string" description: "The name of the connection type spec.\r\n This\ \ can be used as a reference to a paper document where full formal machine\ \ interpretable specs are not supported." connection-spec-id: type: "string" description: "The reference to a formal spec. \r\n This reference\ \ need not be provided (e.g., where there is no formal machine interpretable\ \ spec for the type of connection)." tapi.topology.ConnectionSpecReferenceWrapper: properties: connection-spec-reference: $ref: "#/definitions/tapi.topology.ConnectionSpecReference" tapi.topology.ContextAugmentation4: 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.CostCharacteristicWrapper: properties: cost-characteristic: $ref: "#/definitions/tapi.topology.CostCharacteristic" tapi.topology.ForwardingRule: type: "string" enum: - "MAY_FORWARD_ACROSS_GROUP" - "MUST_FORWARD_ACROSS_GROUP" - "CANNOT_FORWARD_ACROSS_GROUP" - "NO_STATEMENT_ON_FORWARDING" - "INTER_CONNECTION_CONTENTION" 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: "The NodeRuleGroups that the InterRuleGroup constrains interconnection\ \ between.\r\n The CEPs of the NEPs of a referenced NodeRuleGroup\ \ can interconnect to the CEPs of the NEPs of another referenced NodeRuleGroup\ \ constrained by the rules of the InterRuleGroup." items: $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" rule: type: "array" description: "The list of rules of the InterRuleGroup." items: $ref: "#/definitions/tapi.topology.Rule" description: "Rules that apply between groups of NEPs." tapi.topology.InterRuleGroupWrapper: properties: inter-rule-group: $ref: "#/definitions/tapi.topology.InterRuleGroup" 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.LatencyCharacteristicWrapper: properties: latency-characteristic: $ref: "#/definitions/tapi.topology.LatencyCharacteristic" 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" resilience-type: description: "none" $ref: "#/definitions/tapi.topology.ResilienceType" node-edge-point: type: "array" description: "none" items: $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 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.LinkRef: allOf: - $ref: "#/definitions/tapi.topology.TopologyRef" - type: "object" properties: link-uuid: type: "string" description: "none" x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:link/tapi-topology:uuid" description: "none" tapi.topology.LinkRefWrapper: properties: supported-client-link: $ref: "#/definitions/tapi.topology.LinkRef" tapi.topology.LinkWrapper: properties: link: $ref: "#/definitions/tapi.topology.Link" 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.NetworkTopologyServiceWrapper: properties: nw-topology-service: $ref: "#/definitions/tapi.topology.NetworkTopologyService" 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" owned-node-edge-point: type: "array" description: "none" items: $ref: "#/definitions/tapi.topology.NodeEdgePoint" node-rule-group: type: "array" description: "none" items: $ref: "#/definitions/tapi.topology.NodeRuleGroup" 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" 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" 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\ \ 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:owned-node-edge-point/tapi-topology:uuid" description: "none" tapi.topology.NodeEdgePointRefWrapper: properties: node-edge-point: $ref: "#/definitions/tapi.topology.NodeEdgePointRef" 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: "Nested NodeRuleGroups may have InterRuleGroups. The Superior\ \ NodeRuleGroup contains the nested NodeRuleGroups and their associated\ \ InterRuleGroups.\r\n This is equivalent to the Node-Topology\ \ hierarchy." items: $ref: "#/definitions/tapi.topology.InterRuleGroup" rule: type: "array" description: "The list of rules of the NodeRuleGroup." items: $ref: "#/definitions/tapi.topology.Rule" node-rule-group: type: "array" description: "NodeRuleGroups may be nested such that finer grained rules\ \ may be applied.\r\n A nested rule group should have a\ \ subset of the NEPs of the superior rule group." items: $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" node-edge-point: type: "array" description: "NEPs and their client CEPs that the rules apply to." items: $ref: "#/definitions/tapi.topology.NodeEdgePointRef" description: "Rules that apply to a group of NEPs.\r\n " 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.NodeRuleGroupRefWrapper: properties: associated-node-rule-group: $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" tapi.topology.NodeRuleGroupWrapper: properties: node-rule-group: $ref: "#/definitions/tapi.topology.NodeRuleGroup" tapi.topology.PortRoleRule: type: "object" properties: port-role-rule: type: "array" description: "Where the rule references more than one port role or where there\ \ are rule intersections either as a result of overlay of rules or inter\ \ rule group usage indicates role matching criteria for a connection following\ \ the rules.\r\n For example if two port roles, 'a' and 'b',\ \ are listed and the port role rule is 'different', this means that a connection\ \ connecting points in that group must have port roles that are different\ \ for each CEP in that group.\r\n In the example if a connection\ \ can have n ports of role 'a' and m ports of role 'b' then a maximum of\ \ two ports can be drawn from the NEPs of the group and where there are\ \ two, one must be role 'a' and one must be role 'b'." items: type: "string" port-role: type: "array" description: "The role(s) of the port(s) considered in the rule." items: type: "string" tapi.topology.PortRoleRuleWrapper: properties: cep-port-role: $ref: "#/definitions/tapi.topology.PortRoleRule" tapi.topology.ProtectionType: type: "string" enum: - "NO_PROTECTON" - "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" - "ONE_PLUS_ONE_PROTECTION_WITH_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" tapi.topology.ResilienceTypeWrapper: properties: resilience-type: $ref: "#/definitions/tapi.topology.ResilienceType" tapi.topology.RestorationPolicy: type: "string" enum: - "PER_DOMAIN_RESTORATION" - "END_TO_END_RESTORATION" - "NA" 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.RiskCharacteristicWrapper: properties: risk-diversity-characteristic: $ref: "#/definitions/tapi.topology.RiskCharacteristic" 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: complex-rule: type: "array" description: "Allows for more complex rules where the basic rule system\ \ is not sufficient." items: type: "string" rule-type: description: "The focus of the rule." $ref: "#/definitions/tapi.topology.RuleType" signal-property: description: "The rule only applies to signals with the properties listed.\ \ \r\n If the attribute is not present then the rule applies\ \ to all signals." $ref: "#/definitions/tapi.topology.SignalPropertyRule" connection-spec-reference: type: "array" description: "Identifies the type of connection that the rule applies to.\ \ \r\n If the attribute is not present then the rule applies\ \ to all types of connection supported by the device." items: $ref: "#/definitions/tapi.topology.ConnectionSpecReference" cep-port-role: type: "array" description: "Indicates the port role to which the rule applies. \r\n \ \ The port role is interpreted in the context of the connection\ \ type which is identified by the connection spec. \r\n \ \ The port role is not meaningful in the absence of a connection spec\ \ reference.\r\n If a node rule group carries a port role,\ \ that role applies also to the associated inter rule where the combination\ \ of the roles in the node rule groups at the ends of the inter group\ \ rule define the connection orientation.\r\n For example\ \ a root-and-leaf connection may be used in a node where a node rule group\ \ collects one set of NEPs has the port role 'root' and another node rule\ \ group collects another set of NEPs has the port role 'leaf' where these\ \ are joined by an inter rule group. This combination specifies an allowed\ \ orientation of the root-and-leaf connection.\r\n No port\ \ role statement means all port roles are allowed." items: $ref: "#/definitions/tapi.topology.PortRoleRule" cep-direction: type: "array" description: "cep direction is a list of port directions that the rule applies\ \ to.\r\n No entry means all cep directions." items: $ref: "#/definitions/tapi.common.PortDirection" override-priority: type: "integer" format: "int32" description: "The overridePriority allows for one rule in a rule group to\ \ override another.\r\n Priority n rules override priority\ \ n+1 rules.\r\n Rules of the same priority override as\ \ follows (n overrides n+1):\r\n 1 - MustNot\r\n \ \ 2 - Must\r\n 3 - May\r\n 4 -\ \ Null\r\n Within a rule the flexibility rules (signal,\ \ port role...) override as follows (n overriedes n+1):\r\n \ \ 1 - Any\r\n 2 - Same\r\n 3 - Different\r\ \n Where there are two or more 'Same' rules, they will\ \ form an intersection where all must be met.\r\n " layer-protocol-qualifier: type: "array" description: "Qualifies a rule for a particular layerProtocol identifying\ \ the qualifiers that the rule apples to.\r\n If the attribute\ \ is not present then the rule applies to all relevant qualifiers of the\ \ layer protocol of the parent entity." items: type: "string" forwarding-rule: description: "Rule that restricts the creation/deletion of a Connection\ \ between points in the node rule group or related by the inter rule group\ \ between node rule groups." $ref: "#/definitions/tapi.topology.ForwardingRule" description: "Single complex rule statememt.\r\n A Node with no rule\ \ group has no restrictions and is essentially May/Any\r\n A node\ \ rule group constrain the CEP connectability in the Node.\r\n \ \ A connection from a NEP must abide by all rules that relate to that NEP\r\ \n Rules that are for a particular layerProtocolQualifier, connectionSpecReference,\ \ cepPortRole and cepDirection combination must be abided by in combination\ \ as dictated by overridePriority.\r\n If a particular\r\n \ \ - connectionSpecReference does not have any rule statements then\ \ it is not supported and connections of that type are not possible within\ \ the rule group.\r\n - cepPortRole of a particular connectionSpecReference\ \ does not have any rule statements then it is not supported and connections\ \ of that connectionSpecReference (type) cannot have that cepPortRole for\ \ CEPs from NEPs in that rule group.\r\n - cepDirection for a particular\ \ connectionSpecReference does not have any rule statements then it is not\ \ supported and connections of that connectionSpecReference (type) cannot\ \ have that cepPortDirection for CEPs from NEPs in that rule group.\r\n \ \ Rules that are for different layerProtocolQualifiers or connectionSpecReferences\ \ are independent and provide options for connection in the rule group.\r\n\ \ Some rules may apply to multiple connectionSpecReferences and\ \ all cepPortRoles and all cepDirections." tapi.topology.RuleType: type: "string" enum: - "FORWARDING" - "CAPACITY" - "COST" - "TIMING" - "RISK" - "GROUPING" tapi.topology.RuleWrapper: properties: rule: $ref: "#/definitions/tapi.topology.Rule" tapi.topology.SignalPropertyRule: type: "object" properties: number-of-signal-values: type: "integer" format: "int32" description: "The number of instances of this specific property that can be\ \ supported by the group." applicable-signal-value: type: "array" description: "Specific values of the signal property to which the rule applies." items: type: "string" signal-property-value-rule: type: "string" description: "Indicates how the signal properties should be accounted for." signal-property-name: type: "string" description: "The name of the signal property to which the rule applies." tapi.topology.SignalPropertyRuleWrapper: properties: signal-property: $ref: "#/definitions/tapi.topology.SignalPropertyRule" 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" 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.TopologyContextWrapper: properties: tapi-topology:topology-context: $ref: "#/definitions/tapi.topology.TopologyContext" 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.TopologyRefWrapper: properties: topology: $ref: "#/definitions/tapi.topology.TopologyRef" tapi.topology.TopologyWrapper: properties: topology: $ref: "#/definitions/tapi.topology.Topology" 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.ValidationMechanismWrapper: properties: validation-mechanism: $ref: "#/definitions/tapi.topology.ValidationMechanism" 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-or-name: type: "string" description: "none" topology-id-or-name: type: "string" description: "none" tapi.topology.getlinkdetails.Output: type: "object" properties: link: description: "none" $ref: "#/definitions/tapi.topology.Link" tapi.topology.getnodedetails.Input: type: "object" properties: node-id-or-name: type: "string" description: "none" topology-id-or-name: type: "string" description: "none" tapi.topology.getnodedetails.Output: type: "object" properties: node: description: "none" $ref: "#/definitions/tapi.topology.Node" 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: type: "string" description: "none" 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-or-name: type: "string" description: "none" 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.OwnedNodeEdgePoint: allOf: - $ref: "#/definitions/tapi.connectivity.OwnedNodeEdgePointAugmentation1" - $ref: "#/definitions/tapi.topology.NodeEdgePoint" tapi.topology.node.OwnedNodeEdgePointWrapper: properties: owned-node-edge-point: $ref: "#/definitions/tapi.topology.node.OwnedNodeEdgePoint" tapi.topology.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" owned-node-edge-point: type: "array" description: "none" items: $ref: "#/definitions/tapi.topology.node.OwnedNodeEdgePoint" node-rule-group: type: "array" description: "none" items: $ref: "#/definitions/tapi.topology.NodeRuleGroup" aggregated-node-edge-point: type: "array" description: "none" items: $ref: "#/definitions/tapi.topology.NodeEdgePointRef" description: "none" tapi.topology.topology.NodeWrapper: properties: node: $ref: "#/definitions/tapi.topology.topology.Node"